From 5bd98cc473701f2b9dcf170c0877aa130a96bc2c Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 3 Aug 2026 17:21:19 -0500 Subject: [PATCH 1/3] COMDOX-1759: fix broken anchor links in generated GraphQL reference SpectaQL emits type/field cross-references as bare same-page anchors (e.g. `[Cart!](#cart)`), which only worked before the reference was paginated into per-page query/mutation/type chunks. Have generate-spectaql-md.js resolve each link's target heading across all chunks of a schema version and re-point it at the correct page when the target lands elsewhere, leaving genuinely same-page anchors untouched. Regenerated all five schema versions (saas, 2.4.9, 2.4.8, 2.4.7, 2.4.6) with the fix applied. Co-Authored-By: Claude Sonnet 5 --- scripts/generate-spectaql-md.js | 87 +- .../graphql-api-2-4-6-mutations.md | 764 ++-- .../graphql-api-2-4-6-queries.md | 626 ++-- .../graphql-api-2-4-6-types-a-b.md | 750 ++-- .../graphql-api-2-4-6-types-c-e.md | 2626 ++++++------- .../graphql-api-2-4-6-types-f-i.md | 902 ++--- .../graphql-api-2-4-6-types-k-p.md | 1372 +++---- .../graphql-api-2-4-6-types-q-s.md | 871 ++--- .../graphql-api-2-4-6-types-t-z.md | 559 ++- .../graphql-api-2-4-7-mutations.md | 937 ++--- .../graphql-api-2-4-7-queries.md | 960 ++--- .../graphql-api-2-4-7-types-a-b.md | 880 ++--- .../graphql-api-2-4-7-types-c-e.md | 2918 ++++++++------- .../graphql-api-2-4-7-types-f-i.md | 942 ++--- .../graphql-api-2-4-7-types-k-p.md | 1499 ++++---- .../graphql-api-2-4-7-types-q-s.md | 1174 +++--- .../graphql-api-2-4-7-types-t-z.md | 517 +-- .../graphql-api-2-4-8-mutations.md | 1018 +++--- .../graphql-api-2-4-8-queries.md | 1026 +++--- .../graphql-api-2-4-8-types-a-b.md | 1002 +++-- .../graphql-api-2-4-8-types-c-e.md | 3254 ++++++++--------- .../graphql-api-2-4-8-types-f-i.md | 1073 +++--- .../graphql-api-2-4-8-types-k-p.md | 1682 ++++----- .../graphql-api-2-4-8-types-q-s.md | 1302 +++---- .../graphql-api-2-4-8-types-t-z.md | 609 +-- .../graphql-api-2-4-9-mutations.md | 1056 +++--- .../graphql-api-2-4-9-queries.md | 1006 ++--- .../graphql-api-2-4-9-types-a-b.md | 936 +++-- .../graphql-api-2-4-9-types-c-e.md | 3128 ++++++++-------- .../graphql-api-2-4-9-types-f-i.md | 1010 ++--- .../graphql-api-2-4-9-types-k-p.md | 1586 ++++---- .../graphql-api-2-4-9-types-q-s.md | 1320 +++---- .../graphql-api-2-4-9-types-t-z.md | 560 ++- .../graphql-api-saas-mutations.md | 1128 +++--- .../autogenerated/graphql-api-saas-queries.md | 802 ++-- .../graphql-api-saas-types-a-b.md | 870 ++--- .../graphql-api-saas-types-c-e.md | 2866 +++++++-------- .../graphql-api-saas-types-f-i.md | 1042 +++--- .../graphql-api-saas-types-k-p.md | 1639 ++++----- .../graphql-api-saas-types-q-s.md | 1160 +++--- .../graphql-api-saas-types-t-z.md | 493 +-- 41 files changed, 24998 insertions(+), 24954 deletions(-) diff --git a/scripts/generate-spectaql-md.js b/scripts/generate-spectaql-md.js index a5a8351bb..da3b65cc1 100644 --- a/scripts/generate-spectaql-md.js +++ b/scripts/generate-spectaql-md.js @@ -89,6 +89,36 @@ function letterRangeFor(typeName) { return TYPE_LETTER_RANGES.find(range => range.letters.includes(letter)); } +// SpectaQL emits every field/argument type reference as a bare same-page +// anchor, e.g. `[Cart!](#cart)`. That only worked when the whole schema lived +// on one page; now that queries/mutations/types are split across pages, a +// bare anchor is broken unless its target happens to land on the same page +// as the link. Collect every H3 heading's page (case-sensitive, since +// GraphQL names are case-significant — a `cart` query and a `Cart` type are +// different headings) so those links can be re-pointed at the correct page. +function collectHeadingPages(headingToPage, content, pageFile) { + for (const m of content.matchAll(/^### (\S+)/gm)) { + headingToPage.set(m[1], pageFile); + } +} + +// Re-point bare `(#anchor)` links to `pageFile#anchor` when their target +// lives on a different page than the link itself. The link text reliably +// names the target (SpectaQL always links a field/argument to its own type), +// so matching it exactly against the case-sensitive heading map resolves the +// target unambiguously — no need to guess from the anchor text alone. +// List types render as `[Type!]`, nesting a nested `[...]` pair inside the +// label itself, so the label can't be captured with a plain `[^\]]*` — that +// stops at the list type's own inner `]`. Allow one level of nested brackets. +function rewriteBareAnchors(content, currentPageFile, headingToPage) { + return content.replace(/\[((?:[^\[\]\n]|\[[^\[\]\n]*\])*)\]\(#([a-z0-9_-]+)\)/g, (fullMatch, label, anchor) => { + const cleanLabel = label.replace(/`/g, '').replace(/[![\]]/g, '').trim(); + const targetPage = headingToPage.get(cleanLabel); + if (!targetPage || targetPage === currentPageFile) return fullMatch; + return `[${label}](${targetPage}#${anchor})`; + }); +} + // Split the types section at H3 boundaries into fixed alphabetical ranges. function chunkByLetterRange(content) { const parts = content.split(/(?=^### )/m); @@ -270,10 +300,26 @@ for (const schema of toRun) { const sections = parseSections(content); const pageSpecs = []; + // Compute every fragment body up front (page assignment only, no writes + // yet) so bare `(#anchor)` cross-references can be resolved against every + // heading in the schema version before any file hits disk. + const queriesBody = ((sections.preamble || '') + (sections.queries || '')).trimEnd() + '\n'; + const mutationsBody = sections.mutations ? sections.mutations.trimEnd() + '\n' : null; + const subscriptionsBody = sections.subscriptions ? sections.subscriptions.trimEnd() + '\n' : null; + const typeChunks = sections.types ? chunkByLetterRange(sections.types) : []; + + const headingToPage = new Map(); + collectHeadingPages(headingToPage, queriesBody, 'index.md'); + if (mutationsBody) collectHeadingPages(headingToPage, mutationsBody, 'mutations.md'); + if (subscriptionsBody) collectHeadingPages(headingToPage, subscriptionsBody, 'subscriptions.md'); + for (const chunk of typeChunks) { + collectHeadingPages(headingToPage, chunk.content, `types-${chunk.suffix}.md`); + } + // Queries file: preamble (endpoint/header boilerplate) + queries section. { const fragmentFile = `${baseName}-queries.md`; - const body = ((sections.preamble || '') + (sections.queries || '')).trimEnd() + '\n'; + const body = rewriteBareAnchors(queriesBody, 'index.md', headingToPage); fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); console.log(` wrote ${fragmentFile}`); pageSpecs.push({ @@ -286,9 +332,10 @@ for (const schema of toRun) { } // Mutations section. - if (sections.mutations) { + if (mutationsBody) { const fragmentFile = `${baseName}-mutations.md`; - fs.writeFileSync(path.join(outputDir, fragmentFile), sections.mutations.trimEnd() + '\n', 'utf8'); + const body = rewriteBareAnchors(mutationsBody, 'mutations.md', headingToPage); + fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); console.log(` wrote ${fragmentFile}`); pageSpecs.push({ pageFile: 'mutations.md', @@ -301,9 +348,10 @@ for (const schema of toRun) { // Subscriptions section (not present in current schemas, included for // forward-compatibility). - if (sections.subscriptions) { + if (subscriptionsBody) { const fragmentFile = `${baseName}-subscriptions.md`; - fs.writeFileSync(path.join(outputDir, fragmentFile), sections.subscriptions.trimEnd() + '\n', 'utf8'); + const body = rewriteBareAnchors(subscriptionsBody, 'subscriptions.md', headingToPage); + fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); console.log(` wrote ${fragmentFile}`); pageSpecs.push({ pageFile: 'subscriptions.md', @@ -315,21 +363,20 @@ for (const schema of toRun) { } // Types section: split into fixed alphabetical ranges. - if (sections.types) { - 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()), - }); - } + for (const chunk of typeChunks) { + const range = TYPE_LETTER_RANGES.find(entry => entry.suffix === chunk.suffix); + const pageFile = `types-${chunk.suffix}.md`; + const fragmentFile = `${baseName}-types-${chunk.suffix}.md`; + const body = rewriteBareAnchors(chunk.content, pageFile, headingToPage); + fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); + console.log(` wrote ${fragmentFile}`); + pageSpecs.push({ + pageFile, + fragmentFile, + pageTitleSuffix: ` – ${range.navTitle}`, + heading: () => range.heading, + description: meta => schemaDescription(meta, range.navTitle.toLowerCase()), + }); } const autogeneratedDir = path.resolve(ROOT, 'src/pages/includes/autogenerated'); 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 20305cb56..8d98b9fc0 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 @@ -4,13 +4,13 @@ Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -44,13 +44,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -88,13 +88,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -132,14 +132,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -165,7 +165,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -188,14 +188,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -248,13 +248,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -290,7 +290,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -302,14 +302,14 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -335,7 +335,7 @@ mutation addProductsToRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [RequisitionListItemsInput] } ``` @@ -358,14 +358,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -418,13 +418,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -464,13 +464,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -514,14 +514,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -550,7 +550,10 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{"requisitionListUid": 4, "requisitionListItemUids": [4]} +{ + "requisitionListUid": "4", + "requisitionListItemUids": ["4"] +} ``` ##### Response @@ -563,7 +566,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } } } @@ -575,13 +578,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -615,13 +618,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -665,13 +668,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -705,13 +708,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -745,14 +748,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -781,7 +784,10 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": ["4"]} +{ + "wishlistId": "4", + "wishlistItemIds": ["4"] +} ``` ##### Response @@ -806,13 +812,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -846,13 +852,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -886,13 +892,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -926,13 +932,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -966,13 +972,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1016,13 +1022,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1042,7 +1048,7 @@ mutation assignCompareListToCustomer($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -1052,7 +1058,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": false + "result": true } } } @@ -1064,13 +1070,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | | +| `cart_id` - [`String!`](types-q-s.md#string) | | #### Example @@ -1134,7 +1140,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` ##### Response @@ -1153,7 +1159,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, @@ -1161,10 +1167,10 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "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 + "total_quantity": 123.45 } } } @@ -1176,13 +1182,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1226,14 +1232,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | #### Example @@ -1342,7 +1348,7 @@ mutation changeCustomerPassword( ```json { "currentPassword": "abc123", - "newPassword": "xyz789" + "newPassword": "abc123" } ``` @@ -1356,21 +1362,21 @@ mutation changeCustomerPassword( "allow_remote_shopping_assistance": false, "compare_list": CompareList, "created_at": "abc123", - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "xyz789", "default_shipping": "abc123", "dob": "abc123", - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", - "gender": 123, + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group_id": 987, - "id": 123, + "id": 987, "is_subscribed": true, - "job_title": "xyz789", - "lastname": "xyz789", - "middlename": "xyz789", + "job_title": "abc123", + "lastname": "abc123", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -1387,9 +1393,9 @@ mutation changeCustomerPassword( "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "abc123", - "taxvat": "xyz789", + "structure_id": 4, + "suffix": "xyz789", + "taxvat": "abc123", "team": CompanyTeam, "telephone": "xyz789", "wishlist": Wishlist, @@ -1406,13 +1412,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1432,7 +1438,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "xyz789"} +{"cartUid": "abc123"} ``` ##### Response @@ -1451,13 +1457,13 @@ mutation clearCustomerCart($cartUid: String!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1514,15 +1520,15 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -1550,8 +1556,8 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": 4, + "sourceRequisitionListUid": "4", + "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -1574,15 +1580,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -1616,8 +1622,8 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", - "destinationWishlistUid": "4", + "sourceWishlistUid": 4, + "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } ``` @@ -1642,7 +1648,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Example @@ -1659,7 +1665,7 @@ mutation createBraintreeClientToken { ```json { "data": { - "createBraintreeClientToken": "abc123" + "createBraintreeClientToken": "xyz789" } } ``` @@ -1670,13 +1676,13 @@ mutation createBraintreeClientToken { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | #### Example @@ -1710,13 +1716,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | #### Example @@ -1750,13 +1756,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the authenticated customer's company. -**Response:** [`CreateCompanyTeamOutput`](#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | #### Example @@ -1790,13 +1796,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | #### Example @@ -1830,13 +1836,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | #### Example @@ -1884,13 +1890,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -1924,13 +1930,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | #### Example @@ -1989,22 +1995,22 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "customer_id": 123, - "default_billing": false, - "default_shipping": true, + "default_billing": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "xyz789", - "id": 123, + "firstname": "abc123", + "id": 987, "lastname": "abc123", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 987, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "xyz789", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -2016,13 +2022,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2056,13 +2062,13 @@ mutation createCustomerV2($input: CustomerCreateInput!) { Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](#string) +**Response:** [`String`](types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2092,13 +2098,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2136,13 +2142,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -2172,7 +2178,7 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "abc123", + "response_message": "xyz789", "result": 123, "result_code": 987, "secure_token": "abc123", @@ -2188,13 +2194,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2224,7 +2230,7 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { "data": { "createPaypalExpressToken": { "paypal_urls": PaypalExpressUrlList, - "token": "abc123" + "token": "xyz789" } } } @@ -2236,13 +2242,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -2280,13 +2286,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -2330,12 +2336,12 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "xyz789", + "created_at": "abc123", + "created_by": "abc123", "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -2348,13 +2354,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | #### Example @@ -2394,13 +2400,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -2434,13 +2440,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -2472,13 +2478,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -2495,13 +2501,13 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": false}}} +{"data": {"deleteCompanyTeam": {"success": true}}} ``` @@ -2510,13 +2516,13 @@ mutation deleteCompanyTeam($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -2539,7 +2545,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyUser": {"success": true}}} +{"data": {"deleteCompanyUser": {"success": false}}} ``` @@ -2548,13 +2554,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -2571,13 +2577,13 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response ```json -{"data": {"deleteCompareList": {"result": true}}} +{"data": {"deleteCompareList": {"result": false}}} ``` @@ -2586,7 +2592,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Example @@ -2601,7 +2607,7 @@ mutation deleteCustomer { ##### Response ```json -{"data": {"deleteCustomer": true}} +{"data": {"deleteCustomer": false}} ``` @@ -2610,13 +2616,13 @@ mutation deleteCustomer { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -2637,7 +2643,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": true}} +{"data": {"deleteCustomerAddress": false}} ``` @@ -2646,13 +2652,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -2705,13 +2711,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -2731,7 +2737,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "xyz789"} +{"public_hash": "abc123"} ``` ##### Response @@ -2741,7 +2747,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } } } @@ -2753,13 +2759,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -2799,13 +2805,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -2825,7 +2831,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": "4"} +{"requisitionListUid": 4} ``` ##### Response @@ -2835,7 +2841,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { "data": { "deleteRequisitionList": { "requisition_lists": RequisitionLists, - "status": false + "status": true } } } @@ -2847,14 +2853,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -2879,7 +2885,10 @@ mutation deleteRequisitionListItems( ##### Variables ```json -{"requisitionListUid": 4, "requisitionListItemUids": [4]} +{ + "requisitionListUid": "4", + "requisitionListItemUids": ["4"] +} ``` ##### Response @@ -2900,13 +2909,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -2948,14 +2957,14 @@ mutation deleteWishlist($wishlistId: ID!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](#customertoken) +**Response:** [`CustomerToken`](types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -2980,7 +2989,7 @@ mutation generateCustomerToken( ```json { "email": "xyz789", - "password": "xyz789" + "password": "abc123" } ``` @@ -2990,7 +2999,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "abc123" + "token": "xyz789" } } } @@ -3002,13 +3011,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -3046,13 +3055,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -3086,14 +3095,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `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. | +| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -3165,7 +3174,7 @@ mutation mergeCarts( ```json { "source_cart_id": "xyz789", - "destination_cart_id": "xyz789" + "destination_cart_id": "abc123" } ``` @@ -3187,9 +3196,9 @@ mutation mergeCarts( "billing_address": BillingCartAddress, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "is_virtual": true, "items": [CartItemInterface], "prices": CartPrices, @@ -3208,14 +3217,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -3244,7 +3253,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": 4, "giftRegistryUid": "4"} +{"cartUid": 4, "giftRegistryUid": 4} ``` ##### Response @@ -3254,7 +3263,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } } @@ -3267,15 +3276,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -3306,8 +3315,8 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": "4", + "sourceRequisitionListUid": 4, + "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -3331,15 +3340,15 @@ mutation moveItemsBetweenRequisitionLists( Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -3374,7 +3383,7 @@ mutation moveProductsBetweenWishlists( ```json { "sourceWishlistUid": "4", - "destinationWishlistUid": 4, + "destinationWishlistUid": "4", "wishlistItems": [WishlistItemMoveInput] } ``` @@ -3399,13 +3408,13 @@ mutation moveProductsBetweenWishlists( Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -3439,13 +3448,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -3479,13 +3488,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -3523,13 +3532,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | #### Example @@ -3569,13 +3578,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -3619,13 +3628,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -3669,13 +3678,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -3709,13 +3718,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -3749,13 +3758,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -3772,13 +3781,13 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response ```json -{"data": {"removeGiftRegistry": {"success": false}}} +{"data": {"removeGiftRegistry": {"success": true}}} ``` @@ -3787,14 +3796,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -3819,7 +3828,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": 4, "itemsUid": [4]} +{"giftRegistryUid": 4, "itemsUid": ["4"]} ``` ##### Response @@ -3840,14 +3849,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -3874,7 +3883,7 @@ mutation removeGiftRegistryRegistrants( ```json { "giftRegistryUid": "4", - "registrantsUid": ["4"] + "registrantsUid": [4] } ``` @@ -3896,13 +3905,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -3936,13 +3945,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -3982,13 +3991,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove products from the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -4036,14 +4045,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -4071,10 +4080,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemsIds": ["4"] -} +{"wishlistId": 4, "wishlistItemsIds": [4]} ``` ##### Response @@ -4096,13 +4102,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -4136,13 +4142,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -4161,7 +4167,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -4176,13 +4182,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -4216,13 +4222,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](#string) | | +| `orderNumber` - [`String!`](types-q-s.md#string) | | #### Example @@ -4244,7 +4250,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "xyz789"} +{"orderNumber": "abc123"} ``` ##### Response @@ -4266,13 +4272,13 @@ mutation reorderItems($orderNumber: String!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -4310,13 +4316,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | #### Example @@ -4331,7 +4337,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -4346,13 +4352,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -4396,15 +4402,15 @@ mutation requestReturn($input: RequestReturnInput!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | 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!`](types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | #### Example @@ -4428,7 +4434,7 @@ mutation resetPassword( ```json { - "email": "abc123", + "email": "xyz789", "resetPasswordToken": "xyz789", "newPassword": "xyz789" } @@ -4437,7 +4443,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": false}} +{"data": {"resetPassword": true}} ``` @@ -4446,7 +4452,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) #### Example @@ -4472,13 +4478,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -4522,13 +4528,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -4568,13 +4574,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -4608,13 +4614,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -4648,13 +4654,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -4688,13 +4694,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -4734,13 +4740,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -4780,13 +4786,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -4826,13 +4832,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -4876,13 +4882,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -4920,13 +4926,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -4960,13 +4966,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -5000,13 +5006,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -5040,15 +5046,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -5092,13 +5098,13 @@ mutation shareGiftRegistry( Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -5130,13 +5136,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -5170,13 +5176,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | #### Example @@ -5210,13 +5216,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | #### Example @@ -5250,13 +5256,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team. -**Response:** [`UpdateCompanyStructureOutput`](#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | #### Example @@ -5290,13 +5296,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | #### Example @@ -5330,13 +5336,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | #### Example @@ -5370,13 +5376,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -5410,14 +5416,14 @@ mutation updateCustomer($input: CustomerInput!) { Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -5467,7 +5473,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 987, "input": CustomerAddressInput} +{"id": 123, "input": CustomerAddressInput} ``` ##### Response @@ -5476,26 +5482,26 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], - "customer_id": 987, - "default_billing": false, - "default_shipping": true, + "customer_id": 123, + "default_billing": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", "firstname": "abc123", "id": 123, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["xyz789"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "abc123", "vat_id": "xyz789" } @@ -5509,14 +5515,14 @@ mutation updateCustomerAddress( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -5542,8 +5548,8 @@ mutation updateCustomerEmail( ```json { - "email": "xyz789", - "password": "abc123" + "email": "abc123", + "password": "xyz789" } ``` @@ -5559,13 +5565,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -5599,14 +5605,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -5632,7 +5638,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "giftRegistry": UpdateGiftRegistryInput } ``` @@ -5653,14 +5659,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -5686,7 +5692,7 @@ mutation updateGiftRegistryItems( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "items": [UpdateGiftRegistryItemInput] } ``` @@ -5709,14 +5715,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -5742,7 +5748,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -5765,13 +5771,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -5811,14 +5817,14 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -5847,7 +5853,7 @@ mutation updateProductsInWishlist( ```json { - "wishlistId": 4, + "wishlistId": "4", "wishlistItems": [WishlistItemUpdateInput] } ``` @@ -5871,13 +5877,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -5921,10 +5927,10 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", + "created_at": "abc123", "created_by": "abc123", - "description": "abc123", - "name": "xyz789", + "description": "xyz789", + "name": "abc123", "status": "ENABLED", "uid": 4, "updated_at": "xyz789" @@ -5939,14 +5945,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -5995,14 +6001,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -6028,7 +6034,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [ UpdateRequisitionListItemsInput ] @@ -6053,15 +6059,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to update. | -| `name` - [`String`](#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -6101,7 +6107,7 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "abc123", + "name": "xyz789", "uid": "4", "visibility": "PUBLIC" } @@ -6115,13 +6121,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | #### Example 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 1732aef2f..5c234a846 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](#storeconfig) +**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -161,7 +161,7 @@ query availableStores($useCurrentGroup: Boolean) { ##### Variables ```json -{"useCurrentGroup": false} +{"useCurrentGroup": true} ``` ##### Response @@ -172,122 +172,122 @@ query availableStores($useCurrentGroup: Boolean) { "availableStores": [ { "absolute_footer": "abc123", - "allow_gift_receipt": "xyz789", + "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_guests_to_write_product_reviews": "xyz789", "allow_items": "xyz789", "allow_order": "abc123", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, + "autocomplete_on_storefront": true, "base_currency_code": "abc123", "base_link_url": "xyz789", - "base_media_url": "xyz789", - "base_static_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "abc123", "base_url": "abc123", "braintree_cc_vault_active": "xyz789", - "cart_gift_wrapping": "abc123", + "cart_gift_wrapping": "xyz789", "cart_printed_card": "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": false, "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "xyz789", + "check_money_order_make_check_payable_to": "abc123", "check_money_order_max_order_total": "xyz789", "check_money_order_min_order_total": "abc123", - "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_send_check_to": "xyz789", "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", - "cms_home_page": "abc123", - "cms_no_cookies": "xyz789", + "cms_home_page": "xyz789", + "cms_no_cookies": "abc123", "cms_no_route": "xyz789", "code": "xyz789", - "configurable_thumbnail_source": "xyz789", + "configurable_thumbnail_source": "abc123", "copyright": "abc123", - "default_description": "abc123", - "default_display_currency_code": "abc123", - "default_keywords": "xyz789", - "default_title": "abc123", - "demonotice": 123, - "enable_multiple_wishlists": "abc123", + "default_description": "xyz789", + "default_display_currency_code": "xyz789", + "default_keywords": "abc123", + "default_title": "xyz789", + "demonotice": 987, + "enable_multiple_wishlists": "xyz789", "front": "xyz789", - "grid_per_page": 123, - "grid_per_page_values": "xyz789", - "head_includes": "abc123", - "head_shortcut_icon": "abc123", + "grid_per_page": 987, + "grid_per_page_values": "abc123", + "head_includes": "xyz789", + "head_shortcut_icon": "xyz789", "header_logo_src": "xyz789", "id": 123, "is_default_store": true, - "is_default_store_group": false, - "is_negotiable_quote_active": true, + "is_default_store_group": true, + "is_negotiable_quote_active": false, "is_requisition_list_active": "xyz789", - "list_mode": "abc123", - "list_per_page": 123, - "list_per_page_values": "abc123", + "list_mode": "xyz789", + "list_per_page": 987, + "list_per_page_values": "xyz789", "locale": "abc123", - "logo_alt": "abc123", + "logo_alt": "xyz789", "logo_height": 987, - "logo_width": 123, - "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "abc123", - "magento_reward_general_publish_history": "abc123", + "logo_width": 987, + "magento_reward_general_is_enabled": "xyz789", + "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_publish_history": "xyz789", "magento_reward_points_invitation_customer": "xyz789", "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "abc123", - "magento_reward_points_invitation_order_limit": "xyz789", + "magento_reward_points_invitation_order_limit": "abc123", "magento_reward_points_newsletter": "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", - "maximum_number_of_wishlists": "xyz789", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "abc123", + "maximum_number_of_wishlists": "abc123", "minimum_password_length": "xyz789", "no_route": "xyz789", - "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": "xyz789", - "product_url_suffix": "xyz789", - "required_character_classes_number": "abc123", + "product_reviews_enabled": "abc123", + "product_url_suffix": "abc123", + "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": "abc123", - "sales_printed_card": "xyz789", - "secure_base_link_url": "abc123", + "sales_printed_card": "abc123", + "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, - "show_cms_breadcrumbs": 987, + "show_cms_breadcrumbs": 123, "store_code": "4", - "store_group_code": 4, - "store_group_name": "xyz789", - "store_name": "xyz789", + "store_group_code": "4", + "store_group_name": "abc123", + "store_name": "abc123", "store_sort_order": 123, "timezone": "abc123", - "title_prefix": "xyz789", - "title_separator": "xyz789", - "title_suffix": "xyz789", + "title_prefix": "abc123", + "title_separator": "abc123", + "title_suffix": "abc123", "use_store_in_url": false, "website_code": 4, "website_id": 123, - "website_name": "abc123", + "website_name": "xyz789", "weight_unit": "xyz789", "welcome": "abc123", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, + "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" + "zero_subtotal_sort_order": 987, + "zero_subtotal_title": "abc123" } ] } @@ -300,13 +300,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](#cart) +**Response:** [`Cart`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -370,7 +370,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -389,12 +389,12 @@ query cart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "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, @@ -412,15 +412,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](#categoryresult) +**Response:** [`CategoryResult`](types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -482,13 +482,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](#categorytree) +**Response:** [`CategoryTree`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -549,7 +549,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 987} +{"id": 123} ``` ##### Response @@ -559,41 +559,41 @@ query category($id: Int) { "data": { "category": { "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": "xyz789", + "created_at": "abc123", "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", - "description": "xyz789", + "default_sort_by": "xyz789", + "description": "abc123", "display_mode": "abc123", "filter_price_range": 987.65, "id": 123, - "image": "abc123", + "image": "xyz789", "include_in_menu": 987, "is_anchor": 123, - "landing_page": 123, - "level": 123, + "landing_page": 987, + "level": 987, "meta_description": "xyz789", "meta_keywords": "xyz789", "meta_title": "abc123", - "name": "abc123", + "name": "xyz789", "path": "xyz789", - "path_in_store": "xyz789", - "position": 987, + "path_in_store": "abc123", + "position": 123, "product_count": 123, "products": CategoryProducts, "redirect_code": 123, - "relative_url": "xyz789", - "staged": false, + "relative_url": "abc123", + "staged": true, "type": "CMS_PAGE", "uid": "4", - "updated_at": "xyz789", - "url_key": "abc123", - "url_path": "abc123", + "updated_at": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_suffix": "abc123" } } @@ -610,15 +610,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](#categorytree) +**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -701,42 +701,42 @@ query categoryList( "data": { "categoryList": [ { - "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": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "xyz789", + "created_at": "abc123", "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", + "default_sort_by": "xyz789", "description": "abc123", - "display_mode": "abc123", + "display_mode": "xyz789", "filter_price_range": 123.45, "id": 123, - "image": "xyz789", - "include_in_menu": 987, - "is_anchor": 123, - "landing_page": 987, - "level": 987, - "meta_description": "xyz789", + "image": "abc123", + "include_in_menu": 123, + "is_anchor": 987, + "landing_page": 123, + "level": 123, + "meta_description": "abc123", "meta_keywords": "abc123", "meta_title": "abc123", - "name": "abc123", - "path": "xyz789", + "name": "xyz789", + "path": "abc123", "path_in_store": "xyz789", "position": 123, "product_count": 987, "products": CategoryProducts, "redirect_code": 123, "relative_url": "xyz789", - "staged": true, + "staged": false, "type": "CMS_PAGE", - "uid": 4, + "uid": "4", "updated_at": "abc123", "url_key": "abc123", - "url_path": "xyz789", + "url_path": "abc123", "url_suffix": "abc123" } ] @@ -750,7 +750,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) #### Example @@ -777,10 +777,10 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 123, + "agreement_id": 987, "checkbox_text": "xyz789", "content": "abc123", - "content_height": "xyz789", + "content_height": "abc123", "is_html": false, "mode": "AUTO", "name": "abc123" @@ -796,13 +796,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](#cmsblocks) +**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -836,14 +836,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](#cmspage) +**Response:** [`CmsPage`](types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The ID of the CMS page. | -| `identifier` - [`String`](#string) | The identifier of the CMS page. | +| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -877,7 +877,7 @@ query cmsPage( ##### Variables ```json -{"id": 123, "identifier": "xyz789"} +{"id": 987, "identifier": "xyz789"} ``` ##### Response @@ -886,15 +886,15 @@ query cmsPage( { "data": { "cmsPage": { - "content": "xyz789", + "content": "abc123", "content_heading": "xyz789", "identifier": "abc123", - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", "page_layout": "xyz789", "redirect_code": 123, - "relative_url": "abc123", + "relative_url": "xyz789", "title": "abc123", "type": "CMS_PAGE", "url_key": "abc123" @@ -909,7 +909,7 @@ query cmsPage( Return detailed information about the authenticated customer's company. -**Response:** [`Company`](#company) +**Response:** [`Company`](types-c-e.md#company) #### Example @@ -975,13 +975,13 @@ query company { "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "abc123", - "id": 4, + "email": "xyz789", + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "abc123", - "name": "xyz789", - "payment_methods": ["abc123"], - "reseller_id": "abc123", + "name": "abc123", + "payment_methods": ["xyz789"], + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -989,7 +989,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -1001,13 +1001,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1041,9 +1041,9 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -1055,7 +1055,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](#country) +**Response:** [`[Country]`](types-c-e.md#country) #### Example @@ -1084,11 +1084,11 @@ query countries { "countries": [ { "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "xyz789", - "id": "abc123", + "full_name_english": "abc123", + "full_name_locale": "abc123", + "id": "xyz789", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } ] } @@ -1101,13 +1101,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](#country) +**Response:** [`Country`](types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](#string) | | +| `id` - [`String`](types-q-s.md#string) | | #### Example @@ -1141,11 +1141,11 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "xyz789", - "id": "abc123", - "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "full_name_english": "xyz789", + "full_name_locale": "abc123", + "id": "xyz789", + "three_letter_abbreviation": "abc123", + "two_letter_abbreviation": "xyz789" } } } @@ -1157,7 +1157,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](#currency) +**Response:** [`Currency`](types-c-e.md#currency) #### Example @@ -1187,11 +1187,11 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "abc123" + "xyz789" ], - "base_currency_code": "xyz789", - "base_currency_symbol": "abc123", - "default_display_currecy_code": "xyz789", + "base_currency_code": "abc123", + "base_currency_symbol": "xyz789", + "default_display_currecy_code": "abc123", "default_display_currecy_symbol": "xyz789", "default_display_currency_code": "xyz789", "default_display_currency_symbol": "xyz789", @@ -1207,13 +1207,13 @@ query currency { Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1251,7 +1251,7 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Return detailed information about a customer account. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Example @@ -1356,24 +1356,24 @@ query customer { "data": { "customer": { "addresses": [CustomerAddress], - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "compare_list": CompareList, - "created_at": "xyz789", + "created_at": "abc123", "date_of_birth": "xyz789", "default_billing": "abc123", "default_shipping": "abc123", "dob": "xyz789", "email": "abc123", "firstname": "abc123", - "gender": 123, + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group_id": 123, "id": 123, - "is_subscribed": true, + "is_subscribed": false, "job_title": "abc123", - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -1391,7 +1391,7 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "xyz789", + "suffix": "abc123", "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", @@ -1409,7 +1409,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Example @@ -1486,9 +1486,9 @@ 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, @@ -1509,7 +1509,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) #### Example @@ -1545,7 +1545,7 @@ query customerDownloadableProducts { Use the `customer` query instead. -**Response:** [`CustomerOrders`](#customerorders) +**Response:** [`CustomerOrders`](types-c-e.md#customerorders) #### Example @@ -1585,7 +1585,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) #### Example @@ -1617,15 +1617,15 @@ query customerPaymentTokens { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](#dynamicblocks) +**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -1683,13 +1683,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](#hostedprourl) +**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -1727,13 +1727,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](#payflowlinktoken) +**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -1765,7 +1765,7 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "mode": "TEST", "paypal_url": "xyz789", "secure_token": "abc123", - "secure_token_id": "abc123" + "secure_token_id": "xyz789" } } } @@ -1777,13 +1777,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -1815,7 +1815,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "xyz789", - "expiration_date": "abc123" + "expiration_date": "xyz789" } } } @@ -1827,13 +1827,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](#giftregistry) +**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -1886,14 +1886,14 @@ query giftRegistry($giftRegistryUid: ID!) { ], "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "abc123", + "message": "abc123", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } } } @@ -1905,13 +1905,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | #### Example @@ -1943,12 +1943,12 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "abc123", "gift_registry_uid": "4", "location": "abc123", - "name": "abc123", - "type": "abc123" + "name": "xyz789", + "type": "xyz789" } ] } @@ -1961,13 +1961,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -1999,8 +1999,8 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "data": { "giftRegistryIdSearch": [ { - "event_date": "xyz789", - "event_title": "xyz789", + "event_date": "abc123", + "event_title": "abc123", "gift_registry_uid": 4, "location": "xyz789", "name": "xyz789", @@ -2017,15 +2017,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](#string) | The first name of the registrant. | -| `lastName` - [`String!`](#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](#id) | The type UID of the registry. | +| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2057,8 +2057,8 @@ query giftRegistryTypeSearch( ```json { "firstName": "xyz789", - "lastName": "xyz789", - "giftRegistryTypeUid": 4 + "lastName": "abc123", + "giftRegistryTypeUid": "4" } ``` @@ -2070,9 +2070,9 @@ query giftRegistryTypeSearch( "giftRegistryTypeSearch": [ { "event_date": "abc123", - "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "xyz789", + "event_title": "abc123", + "gift_registry_uid": 4, + "location": "abc123", "name": "xyz789", "type": "xyz789" } @@ -2087,7 +2087,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](#giftregistrytype) +**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) #### Example @@ -2115,8 +2115,8 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", - "uid": "4" + "label": "abc123", + "uid": 4 } ] } @@ -2129,13 +2129,13 @@ query giftRegistryTypes { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2152,7 +2152,7 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2167,13 +2167,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2190,7 +2190,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2205,13 +2205,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](#string) | | +| `name` - [`String!`](types-q-s.md#string) | | #### Example @@ -2228,7 +2228,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "xyz789"} +{"name": "abc123"} ``` ##### Response @@ -2243,13 +2243,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2272,7 +2272,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}} ``` @@ -2281,13 +2281,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to check. | +| `email` - [`String!`](types-q-s.md#string) | The email address to check. | #### Example @@ -2304,7 +2304,7 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2319,13 +2319,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](#negotiablequote) +**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | | +| `uid` - [`ID!`](types-f-i.md#id) | | #### Example @@ -2376,7 +2376,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -2391,10 +2391,10 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "email": "abc123", + "created_at": "abc123", + "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "name": "abc123", "prices": CartPrices, @@ -2403,9 +2403,9 @@ query negotiableQuote($uid: ID!) { NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -2417,16 +2417,16 @@ query negotiableQuote($uid: ID!) { Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -2479,7 +2479,7 @@ query negotiableQuotes( "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -2491,18 +2491,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](#pickuplocations) +**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -2569,7 +2569,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) #### Example @@ -2603,17 +2603,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](#products) +**Response:** [`Products`](types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -2681,7 +2681,7 @@ query products( "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } } } @@ -2693,13 +2693,13 @@ query products( Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](#routableinterface) +**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#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": 123, - "relative_url": "abc123", + "redirect_code": 987, + "relative_url": "xyz789", "type": "CMS_PAGE" } } @@ -2741,7 +2741,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](#storeconfig) +**Response:** [`StoreConfig`](types-q-s.md#storeconfig) #### Example @@ -2879,11 +2879,11 @@ query storeConfig { { "data": { "storeConfig": { - "absolute_footer": "abc123", - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", + "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": "abc123", + "allow_guests_to_write_product_reviews": "xyz789", "allow_items": "xyz789", "allow_order": "abc123", "allow_printed_card": "abc123", @@ -2892,110 +2892,110 @@ query storeConfig { "base_link_url": "abc123", "base_media_url": "abc123", "base_static_url": "abc123", - "base_url": "xyz789", - "braintree_cc_vault_active": "abc123", - "cart_gift_wrapping": "abc123", - "cart_printed_card": "xyz789", + "base_url": "abc123", + "braintree_cc_vault_active": "xyz789", + "cart_gift_wrapping": "xyz789", + "cart_printed_card": "abc123", "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": false, + "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_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": "xyz789", + "check_money_order_new_order_status": "abc123", + "check_money_order_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "abc123", "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", "cms_home_page": "abc123", - "cms_no_cookies": "abc123", - "cms_no_route": "abc123", + "cms_no_cookies": "xyz789", + "cms_no_route": "xyz789", "code": "abc123", "configurable_thumbnail_source": "xyz789", - "copyright": "abc123", - "default_description": "abc123", + "copyright": "xyz789", + "default_description": "xyz789", "default_display_currency_code": "abc123", "default_keywords": "abc123", "default_title": "abc123", "demonotice": 123, "enable_multiple_wishlists": "abc123", - "front": "abc123", + "front": "xyz789", "grid_per_page": 987, "grid_per_page_values": "abc123", - "head_includes": "abc123", - "head_shortcut_icon": "abc123", - "header_logo_src": "abc123", - "id": 123, + "head_includes": "xyz789", + "head_shortcut_icon": "xyz789", + "header_logo_src": "xyz789", + "id": 987, "is_default_store": false, "is_default_store_group": true, "is_negotiable_quote_active": true, "is_requisition_list_active": "abc123", "list_mode": "xyz789", - "list_per_page": 987, - "list_per_page_values": "abc123", + "list_per_page": 123, + "list_per_page_values": "xyz789", "locale": "abc123", "logo_alt": "abc123", - "logo_height": 123, + "logo_height": 987, "logo_width": 987, "magento_reward_general_is_enabled": "xyz789", - "magento_reward_general_is_enabled_on_front": "xyz789", + "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_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": "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": "abc123", - "maximum_number_of_wishlists": "xyz789", - "minimum_password_length": "xyz789", - "no_route": "abc123", - "payment_payflowpro_cc_vault_active": "xyz789", + "magento_wishlist_general_is_enabled": "xyz789", + "maximum_number_of_wishlists": "abc123", + "minimum_password_length": "abc123", + "no_route": "xyz789", + "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "xyz789", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "abc123", + "product_reviews_enabled": "xyz789", "product_url_suffix": "xyz789", "required_character_classes_number": "xyz789", - "returns_enabled": "abc123", - "root_category_id": 987, + "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_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, - "show_cms_breadcrumbs": 987, - "store_code": "4", + "show_cms_breadcrumbs": 123, + "store_code": 4, "store_group_code": "4", - "store_group_name": "xyz789", + "store_group_name": "abc123", "store_name": "xyz789", - "store_sort_order": 987, - "timezone": "abc123", + "store_sort_order": 123, + "timezone": "xyz789", "title_prefix": "abc123", "title_separator": "abc123", "title_suffix": "abc123", - "use_store_in_url": false, + "use_store_in_url": true, "website_code": 4, "website_id": 123, "website_name": "abc123", "weight_unit": "xyz789", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, + "welcome": "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_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" } } } @@ -3011,13 +3011,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](#entityurl) +**Response:** [`EntityUrl`](types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#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": "abc123", - "entity_uid": 4, - "id": 123, - "redirectCode": 987, + "canonical_url": "xyz789", + "entity_uid": "4", + "id": 987, + "redirectCode": 123, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -3069,7 +3069,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](#wishlistoutput) +**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) #### Example @@ -3097,7 +3097,7 @@ query wishlist { "wishlist": { "items": [WishlistItem], "items_count": 987, - "name": "abc123", + "name": "xyz789", "sharing_code": "abc123", "updated_at": "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 index 2be238211..dd634640c 100644 --- 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 @@ -8,7 +8,7 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example @@ -30,7 +30,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -48,8 +48,8 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example @@ -70,7 +70,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -86,14 +86,14 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [DownloadableProductCartItemInput] } ``` @@ -108,7 +108,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -126,10 +126,10 @@ Defines a new registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | #### Example @@ -139,7 +139,7 @@ Defines a new registrant. GiftRegistryDynamicAttributeInput ], "email": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123" } ``` @@ -154,7 +154,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -172,8 +172,8 @@ Contains details about the cart after adding products to it. | 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. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -194,8 +194,8 @@ Contains products to add to an existing compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example @@ -213,7 +213,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -231,8 +231,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -253,14 +253,14 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { - "comment": "xyz789", + "comment": "abc123", "purchase_order_uid": "4" } ``` @@ -275,7 +275,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -293,15 +293,15 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "purchase_order_uid": "4", "replace_existing_cart_items": true } @@ -317,7 +317,7 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | +| `message` - [`String!`](types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example @@ -359,7 +359,7 @@ Output of the request to add items in a requisition list to the cart. | 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. | +| `cart` - [`Cart`](types-c-e.md#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 @@ -384,14 +384,14 @@ Defines a return comment. | 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. | +| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example ```json { - "comment_text": "xyz789", + "comment_text": "abc123", "return_uid": "4" } ``` @@ -406,7 +406,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `return` - [`Return`](types-q-s.md#return) | The modified return. | #### Example @@ -424,17 +424,17 @@ Defines tracking information to be added to the return. | 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. | +| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { "carrier_uid": 4, - "return_uid": 4, - "tracking_number": "xyz789" + "return_uid": "4", + "tracking_number": "abc123" } ``` @@ -448,8 +448,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -470,14 +470,14 @@ Defines the simple and group products to add to the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [SimpleProductCartItemInput] } ``` @@ -492,7 +492,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -510,8 +510,8 @@ Defines the virtual products to add to the cart. | 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_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example @@ -532,7 +532,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -550,9 +550,9 @@ Contains the resultant wish list and any error information. | 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. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#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. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -576,11 +576,11 @@ Contains information for each filterable option (such as price, category `UID`, | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](types-q-s.md#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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example @@ -590,7 +590,7 @@ Contains information for each filterable option (such as price, category `UID`, "count": 123, "label": "abc123", "options": [AggregationOption], - "position": 123 + "position": 987 } ``` @@ -604,16 +604,16 @@ An implementation of `AggregationOptionInterface`. | 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example ```json { "count": 123, - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -628,9 +628,9 @@ Defines aggregation option 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -643,7 +643,7 @@ Defines aggregation option fields. ```json { "count": 987, - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -694,7 +694,7 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example @@ -712,10 +712,10 @@ Contains an applied gift card with applied and remaining balance. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -724,7 +724,7 @@ Contains an applied gift card with applied and remaining balance. "applied_balance": Money, "code": "abc123", "current_balance": Money, - "expiration_date": "xyz789" + "expiration_date": "abc123" } ``` @@ -738,8 +738,8 @@ Contains the applied and current balances. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](types-k-p.md#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 @@ -762,15 +762,15 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | #### Example ```json { "cart_id": "abc123", - "coupon_code": "abc123" + "coupon_code": "xyz789" } ``` @@ -784,7 +784,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -802,14 +802,14 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "gift_card_code": "abc123" } ``` @@ -824,7 +824,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -842,7 +842,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -860,12 +860,12 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -878,7 +878,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -896,13 +896,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | 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. | +| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 123, "search_term": "xyz789"} +{"radius": 123, "search_term": "abc123"} ``` @@ -915,7 +915,7 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | | `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | #### Example @@ -934,12 +934,12 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](types-q-s.md#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. | +| `attribute_type` - [`String`](types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example @@ -947,7 +947,7 @@ Contains details about the attribute, including the code and type. { "attribute_code": "xyz789", "attribute_options": [AttributeOption], - "attribute_type": "abc123", + "attribute_type": "xyz789", "entity_type": "xyz789", "input_type": "abc123", "storefront_properties": StorefrontProperties @@ -964,8 +964,8 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | #### Example @@ -986,15 +986,15 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](types-q-s.md#string) | The attribute option value. | #### Example ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -1008,13 +1008,13 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | #### Example ```json -{"code": "AFN", "symbol": "xyz789"} +{"code": "AFN", "symbol": "abc123"} ``` @@ -1027,17 +1027,17 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `title` - [`String!`](types-q-s.md#string) | The payment method title. | #### Example ```json { "code": "abc123", - "is_deferred": true, - "title": "abc123" + "is_deferred": false, + "title": "xyz789" } ``` @@ -1051,16 +1051,16 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1069,11 +1069,11 @@ Contains details about the possible shipping methods and carriers. "amount": Money, "available": true, "base_amount": Money, - "carrier_code": "xyz789", + "carrier_code": "abc123", "carrier_title": "abc123", - "error_message": "abc123", - "method_code": "xyz789", - "method_title": "xyz789", + "error_message": "xyz789", + "method_code": "abc123", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1107,8 +1107,8 @@ Defines the billing address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](types-f-i.md#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. | @@ -1118,7 +1118,7 @@ Defines the billing address. { "address": CartAddressInput, "customer_address_id": 123, - "same_as_shipping": false, + "same_as_shipping": true, "use_for_shipping": false } ``` @@ -1133,18 +1133,18 @@ Contains details about the billing address. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `customer_notes` - [`String`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example @@ -1154,14 +1154,14 @@ Contains details about the billing address. "company": "xyz789", "country": CartAddressCountry, "customer_notes": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "postcode": "xyz789", "region": CartAddressRegion, "street": ["xyz789"], "telephone": "abc123", - "uid": "xyz789", - "vat_id": "abc123" + "uid": "abc123", + "vat_id": "xyz789" } ``` @@ -1179,14 +1179,14 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `device_data` - [`String`](types-q-s.md#string) | | +| `public_hash` - [`String!`](types-q-s.md#string) | | #### Example ```json { - "device_data": "xyz789", + "device_data": "abc123", "public_hash": "xyz789" } ``` @@ -1199,15 +1199,15 @@ The `Boolean` scalar type represents `true` or `false`. | 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. | +| `device_data` - [`String`](types-q-s.md#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. | +| `payment_method_nonce` - [`String!`](types-q-s.md#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", + "device_data": "xyz789", "is_active_payment_token_enabler": true, "payment_method_nonce": "xyz789" } @@ -1223,23 +1223,23 @@ Contains details about an individual category that comprises a breadcrumb. | 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. | +| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](types-f-i.md#int) | The category level. | +| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | #### Example ```json { - "category_id": 987, - "category_level": 123, + "category_id": 123, + "category_level": 987, "category_name": "xyz789", - "category_uid": "4", - "category_url_key": "xyz789", - "category_url_path": "xyz789" + "category_uid": 4, + "category_url_key": "abc123", + "category_url_path": "abc123" } ``` @@ -1253,17 +1253,17 @@ An implementation for bundle product cart items. | 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. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1293,14 +1293,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -1310,7 +1310,7 @@ Defines bundle product options for `CreditMemoItemInterface`. "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 123.45 @@ -1327,14 +1327,14 @@ Defines bundle product options for `InvoiceItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1342,12 +1342,12 @@ Defines bundle product options for `InvoiceItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "product_sku": "abc123", + "quantity_invoiced": 123.45 } ``` @@ -1361,15 +1361,15 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](types-f-i.md#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 | +| `position` - [`Int`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](types-k-p.md#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. | +| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example @@ -1379,8 +1379,8 @@ Defines an individual item within a bundle product. "options": [BundleItemOption], "position": 987, "price_range": PriceRange, - "required": false, - "sku": "xyz789", + "required": true, + "sku": "abc123", "title": "abc123", "type": "xyz789", "uid": 4 @@ -1398,30 +1398,30 @@ Defines the characteristics that comprise a specific bundle item and its options | 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)* | +| `id` - [`Int`](types-f-i.md#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. | +| `label` - [`String`](types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { "can_change_quantity": false, - "id": 123, + "id": 987, "is_default": true, "label": "xyz789", - "position": 123, - "price": 987.65, + "position": 987, + "price": 123.45, "price_type": "FIXED", "product": ProductInterface, - "qty": 987.65, + "qty": 123.45, "quantity": 123.45, "uid": "4" } @@ -1437,15 +1437,15 @@ Defines the input for a bundle option. | 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. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | #### Example ```json { - "id": 987, + "id": 123, "quantity": 987.65, "value": ["abc123"] } @@ -1461,26 +1461,26 @@ Defines bundle product options for `OrderItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -1493,19 +1493,19 @@ Defines bundle product options for `OrderItemInterface`. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": 4, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "abc123", + "product_sku": "xyz789", + "product_type": "xyz789", + "product_url_key": "xyz789", "quantity_canceled": 987.65, "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, + "quantity_ordered": 123.45, "quantity_refunded": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -1519,103 +1519,103 @@ Defines basic features of a bundle product and contains multiple BundleItems. | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](types-c-e.md#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. | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#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. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "xyz789", + "activity": "abc123", "attribute_set_id": 987, "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "xyz789", "climate": "xyz789", "collar": "abc123", - "color": 987, + "color": 123, "country_of_manufacture": "xyz789", "created_at": "abc123", "crosssell_products": [ProductInterface], @@ -1624,74 +1624,74 @@ Defines basic features of a bundle product and contains multiple BundleItems. "dynamic_sku": false, "dynamic_weight": true, "eco_collection": 123, - "erin_recommends": 123, - "features_bags": "abc123", - "format": 987, + "erin_recommends": 987, + "features_bags": "xyz789", + "format": 123, "gender": "abc123", - "gift_message_available": "xyz789", - "id": 987, + "gift_message_available": "abc123", + "id": 123, "image": ProductImage, "is_returnable": "abc123", "items": [BundleItem], - "manufacturer": 123, + "manufacturer": 987, "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "name": "abc123", - "new": 987, - "new_from_date": "abc123", + "new": 123, + "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "abc123", - "pattern": "xyz789", - "performance_fabric": 987, + "pattern": "abc123", + "performance_fabric": 123, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], - "purpose": 987, + "purpose": 123, "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 123, "reviews": ProductReviews, "sale": 123, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "size": 123, - "sku": "abc123", + "size": 987, + "sku": "xyz789", "sleeve": "abc123", "small_image": ProductImage, "special_from_date": "xyz789", "special_price": 123.45, - "special_to_date": "abc123", - "staged": true, + "special_to_date": "xyz789", + "staged": false, "stock_status": "IN_STOCK", - "strap_bags": "abc123", + "strap_bags": "xyz789", "style_bags": "xyz789", "style_bottom": "xyz789", - "style_general": "xyz789", + "style_general": "abc123", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", + "type_id": "xyz789", "uid": "4", "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -1706,8 +1706,8 @@ Defines a single bundle product. | 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -1729,11 +1729,11 @@ Contains details about bundle products added to a requisition list. | 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. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -1742,7 +1742,7 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" } ``` @@ -1757,25 +1757,25 @@ Defines bundle product options for `ShipmentItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example ```json { "bundle_options": [ItemSelectedBundleOption], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -1789,25 +1789,25 @@ Defines bundle product options for `WishlistItemInterface`. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md index b1537c38c..4d51c52ed 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md @@ -8,26 +8,26 @@ Contains the contents and other details about a guest or customer cart. | 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. | +| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](types-a-b.md#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. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -43,13 +43,13 @@ Contains the contents and other details about a guest or customer cart. "billing_address": BillingCartAddress, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": false, + "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 @@ -66,15 +66,15 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `code` - [`String!`](types-q-s.md#string) | The country code. | +| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | #### Example ```json { "code": "abc123", - "label": "xyz789" + "label": "abc123" } ``` @@ -88,28 +88,28 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { "city": "xyz789", - "company": "xyz789", - "country_code": "xyz789", - "firstname": "abc123", - "lastname": "abc123", + "company": "abc123", + "country_code": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", "postcode": "abc123", "region": "xyz789", "region_id": 987, @@ -128,39 +128,39 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | +| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | #### Example ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": CartAddressCountry, "firstname": "abc123", "lastname": "abc123", "postcode": "xyz789", "region": CartAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "telephone": "xyz789", - "uid": "xyz789", + "uid": "abc123", "vat_id": "xyz789" } ``` @@ -175,17 +175,17 @@ Contains details about the region in a billing or shipping address. | 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`](types-q-s.md#string) | The state or province code. | +| `label` - [`String`](types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "abc123", - "label": "abc123", - "region_id": 123 + "code": "xyz789", + "label": "xyz789", + "region_id": 987 } ``` @@ -199,15 +199,15 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | #### Example ```json { "amount": Money, - "label": ["xyz789"] + "label": ["abc123"] } ``` @@ -220,12 +220,12 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | #### Example ```json -{"code": "UNDEFINED", "message": "xyz789"} +{"code": "UNDEFINED", "message": "abc123"} ``` @@ -257,17 +257,17 @@ Defines an item to be added to the cart. | 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. | +| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | #### Example ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", + "parent_sku": "xyz789", "quantity": 987.65, "selected_options": [4], "sku": "xyz789" @@ -285,21 +285,21 @@ An interface for products in a cart. | Field Name | Description | |------------|-------------| | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `id` - [`String!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | +| [`SimpleCartItem`](types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | +| [`BundleCartItem`](types-a-b.md#bundlecartitem) | +| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | #### Example @@ -307,11 +307,11 @@ An interface for products in a cart. ```json { "errors": [CartItemError], - "id": "abc123", + "id": "xyz789", "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -326,12 +326,12 @@ Contains details about the price of the item, including taxes and discounts. | 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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -357,13 +357,13 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | 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`.)* | +| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart_item_id": 987, "quantity": 123.45} +{"cart_item_id": 987, "quantity": 987.65} ``` @@ -376,17 +376,17 @@ Contains details about the price of a selected customizable value. | 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. | +| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](types-f-i.md#float) | A price value. | #### Example ```json { "type": "FIXED", - "units": "abc123", - "value": 987.65 + "units": "xyz789", + "value": 123.45 } ``` @@ -400,23 +400,23 @@ A single item to be updated. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | #### Example ```json { - "cart_item_id": 123, + "cart_item_id": 987, "cart_item_uid": "4", "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, - "gift_wrapping_id": "4", - "quantity": 987.65 + "gift_wrapping_id": 4, + "quantity": 123.45 } ``` @@ -433,11 +433,11 @@ Contains details about the final price of items in the cart, including discount | `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. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -464,8 +464,8 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | #### Example @@ -487,7 +487,7 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -528,13 +528,13 @@ Defines the filters to be used in the search. A filter contains at least one att | 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. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -560,39 +560,39 @@ Contains the full set of attributes that can be returned in a category search. | 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) | | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -607,35 +607,35 @@ Contains the full set of attributes that can be returned in a category search. "automatic_sorting": "abc123", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", - "children_count": "abc123", + "canonical_url": "xyz789", + "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "abc123", + "created_at": "xyz789", "custom_layout_update_file": "abc123", "default_sort_by": "abc123", "description": "xyz789", "display_mode": "xyz789", - "filter_price_range": 123.45, + "filter_price_range": 987.65, "id": 987, - "image": "xyz789", + "image": "abc123", "include_in_menu": 123, "is_anchor": 123, "landing_page": 987, - "level": 987, - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "xyz789", + "level": 123, + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "abc123", "name": "xyz789", "path": "abc123", - "path_in_store": "abc123", - "position": 987, + "path_in_store": "xyz789", + "position": 123, "product_count": 987, "products": CategoryProducts, "staged": false, - "uid": "4", + "uid": 4, "updated_at": "abc123", "url_key": "xyz789", - "url_path": "abc123", + "url_path": "xyz789", "url_suffix": "abc123" } ``` @@ -650,9 +650,9 @@ Contains details about the products assigned to a category. | 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. | +| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -660,7 +660,7 @@ Contains details about the products assigned to a category. { "items": [ProductInterface], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -675,8 +675,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -684,7 +684,7 @@ Contains a collection of `CategoryTree` objects and pagination information. { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -698,43 +698,43 @@ Contains the hierarchy of categories. | 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. | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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) | | +| `children_count` - [`String`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example @@ -743,40 +743,40 @@ Contains the hierarchy of categories. "automatic_sorting": "abc123", "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "xyz789", + "created_at": "abc123", "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, + "description": "abc123", + "display_mode": "xyz789", + "filter_price_range": 123.45, + "id": 123, + "image": "abc123", + "include_in_menu": 123, "is_anchor": 123, "landing_page": 987, "level": 123, - "meta_description": "abc123", - "meta_keywords": "xyz789", + "meta_description": "xyz789", + "meta_keywords": "abc123", "meta_title": "abc123", - "name": "abc123", + "name": "xyz789", "path": "xyz789", - "path_in_store": "abc123", + "path_in_store": "xyz789", "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": "abc123", - "url_key": "xyz789", + "updated_at": "xyz789", + "url_key": "abc123", "url_path": "xyz789", - "url_suffix": "xyz789" + "url_suffix": "abc123" } ``` @@ -790,23 +790,23 @@ Defines details about an individual checkout agreement. | 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. | +| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](types-a-b.md#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. | +| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | #### Example ```json { "agreement_id": 123, - "checkbox_text": "abc123", + "checkbox_text": "xyz789", "content": "xyz789", - "content_height": "abc123", - "is_html": false, + "content_height": "xyz789", + "is_html": true, "mode": "AUTO", "name": "xyz789" } @@ -842,8 +842,8 @@ An error encountered while adding an item to the cart. | 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 | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](types-q-s.md#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 @@ -886,7 +886,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -902,9 +902,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -923,7 +923,7 @@ Contains details about a failed close operation on a negotiable quote. | 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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -942,7 +942,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -961,12 +961,12 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{"quote_uids": [4]} +{"quote_uids": ["4"]} ``` @@ -979,10 +979,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | 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 | +| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1007,15 +1007,15 @@ Contains details about a specific CMS block. | 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. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | #### Example ```json { - "content": "abc123", + "content": "xyz789", "identifier": "abc123", "title": "abc123" } @@ -1049,32 +1049,32 @@ Contains details about a CMS page. | 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`. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { "content": "abc123", - "content_heading": "abc123", - "identifier": "xyz789", - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", + "content_heading": "xyz789", + "identifier": "abc123", + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", "page_layout": "abc123", "redirect_code": 987, - "relative_url": "abc123", + "relative_url": "xyz789", "title": "xyz789", "type": "CMS_PAGE", "url_key": "abc123" @@ -1089,7 +1089,7 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -1111,13 +1111,13 @@ Contains the output schema for a 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](types-f-i.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](types-q-s.md#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. | @@ -1125,7 +1125,7 @@ Contains the output schema for a company. | `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. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1135,7 +1135,7 @@ Contains the output schema for a company. "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "abc123", + "email": "xyz789", "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", @@ -1164,17 +1164,17 @@ Contains details about the access control list settings of a resource. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | #### Example ```json { "children": [CompanyAclResource], - "id": "4", - "sort_order": 123, + "id": 4, + "sort_order": 987, "text": "xyz789" } ``` @@ -1189,11 +1189,11 @@ Defines the input schema for creating a company administrator. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | #### Example @@ -1202,7 +1202,7 @@ Defines the input schema for creating a company administrator. "email": "abc123", "firstname": "abc123", "gender": 987, - "job_title": "abc123", + "job_title": "xyz789", "lastname": "abc123" } ``` @@ -1218,12 +1218,12 @@ Defines the input schema for creating a new company. | 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. | +| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1233,9 +1233,9 @@ Defines the input schema for creating a new company. "company_email": "abc123", "company_name": "xyz789", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "xyz789", + "legal_name": "abc123", "reseller_id": "abc123", - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } ``` @@ -1249,9 +1249,9 @@ Contains company credit balances and limits. | 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. | +| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](types-k-p.md#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 @@ -1274,8 +1274,8 @@ Contains details about prior company credit operations. | 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. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1283,7 +1283,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1297,9 +1297,9 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](types-q-s.md#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. | +| `updated_by` - [`String`](types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example @@ -1321,10 +1321,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `amount` - [`Money`](types-k-p.md#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. | +| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](types-q-s.md#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. | @@ -1334,8 +1334,8 @@ Contains details about a single company credit operation. { "amount": Money, "balance": CompanyCredit, - "custom_reference_number": "xyz789", - "date": "xyz789", + "custom_reference_number": "abc123", + "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser } @@ -1372,7 +1372,7 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](types-q-s.md#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 @@ -1408,12 +1408,12 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | #### Example @@ -1424,7 +1424,7 @@ Contains details about the address where the company is registered to conduct bu "postcode": "xyz789", "region": CustomerAddressRegion, "street": ["abc123"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1438,20 +1438,20 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](types-q-s.md#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. | +| `postcode` - [`String!`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["abc123"], "telephone": "xyz789" @@ -1468,22 +1468,22 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", "postcode": "abc123", "region": CustomerAddressRegionInput, - "street": ["abc123"], + "street": ["xyz789"], "telephone": "abc123" } ``` @@ -1498,19 +1498,19 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#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. | +| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { - "id": 4, - "name": "xyz789", + "id": "4", + "name": "abc123", "permissions": [CompanyAclResource], - "users_count": 123 + "users_count": 987 } ``` @@ -1524,15 +1524,15 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { "name": "xyz789", - "permissions": ["xyz789"] + "permissions": ["abc123"] } ``` @@ -1546,17 +1546,17 @@ Defines the input schema for updating a company role. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "id": "4", - "name": "abc123", - "permissions": ["abc123"] + "id": 4, + "name": "xyz789", + "permissions": ["xyz789"] } ``` @@ -1571,8 +1571,8 @@ Contains an array of roles. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -1594,17 +1594,17 @@ Contains details about a company sales representative. | 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -1654,13 +1654,17 @@ Defines an individual node in the company structure. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example ```json -{"entity": CompanyTeam, "id": 4, "parent_id": 4} +{ + "entity": CompanyTeam, + "id": "4", + "parent_id": 4 +} ``` @@ -1673,13 +1677,13 @@ Defines the input schema for updating the company structure. | 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. | +| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": 4, "tree_id": "4"} +{"parent_tree_id": "4", "tree_id": 4} ``` @@ -1692,10 +1696,10 @@ Describes a company team. | 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 | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | #### Example @@ -1718,9 +1722,9 @@ Defines the input schema for creating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example @@ -1742,17 +1746,17 @@ Defines the input schema for updating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | #### Example ```json { "description": "xyz789", - "id": "4", - "name": "xyz789" + "id": 4, + "name": "abc123" } ``` @@ -1766,23 +1770,23 @@ Defines the input schema for updating a company. | 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. | +| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "company_email": "abc123", - "company_name": "abc123", + "company_email": "xyz789", + "company_name": "xyz789", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "xyz789", - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } ``` @@ -1796,27 +1800,27 @@ Defines the input schema for creating a company user. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](types-f-i.md#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. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", - "firstname": "xyz789", + "email": "abc123", + "firstname": "abc123", "job_title": "abc123", - "lastname": "xyz789", + "lastname": "abc123", "role_id": "4", "status": "ACTIVE", - "target_id": 4, - "telephone": "abc123" + "target_id": "4", + "telephone": "xyz789" } ``` @@ -1849,27 +1853,27 @@ Defines the input schema for updating a company user. | 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. | +| `email` - [`String`](types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](types-f-i.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", - "firstname": "xyz789", + "email": "abc123", + "firstname": "abc123", "id": 4, "job_title": "xyz789", - "lastname": "abc123", + "lastname": "xyz789", "role_id": "4", "status": "ACTIVE", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1884,8 +1888,8 @@ Contains details about company users. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | #### Example @@ -1925,15 +1929,15 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | #### Example ```json { - "code": "abc123", - "label": "abc123" + "code": "xyz789", + "label": "xyz789" } ``` @@ -1947,9 +1951,9 @@ Defines an object used to iterate through items for product comparisons. | 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. | +| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -1972,18 +1976,18 @@ Contains iterable information such as the array of items, the count, and attribu | 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. | +| `item_count` - [`Int!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } ``` @@ -1995,12 +1999,12 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | #### Example ```json -{"html": "xyz789"} +{"html": "abc123"} ``` @@ -2013,19 +2017,19 @@ Contains details about a configurable product attribute option. | 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. | +| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "code": "abc123", - "label": "abc123", - "uid": "4", - "value_index": 987 + "code": "xyz789", + "label": "xyz789", + "uid": 4, + "value_index": 123 } ``` @@ -2039,18 +2043,18 @@ An implementation for configurable product cart items. | 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. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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.)* | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2067,7 +2071,7 @@ An implementation for configurable product cart items. "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -2081,15 +2085,15 @@ Describes configurable options that have been selected and can be selected as a | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { "attribute_code": "xyz789", - "option_value_uids": ["4"] + "option_value_uids": [4] } ``` @@ -2103,115 +2107,115 @@ Defines basic features of a configurable product and its simple product variants | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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.)* | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#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 | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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.)* | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](types-f-i.md#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 | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "xyz789", - "attribute_set_id": 123, - "canonical_url": "xyz789", + "activity": "abc123", + "attribute_set_id": 987, + "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "abc123", + "category_gear": "xyz789", "climate": "abc123", "collar": "xyz789", - "color": 123, + "color": 987, "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, "country_of_manufacture": "abc123", "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, - "eco_collection": 123, + "eco_collection": 987, "erin_recommends": 987, - "features_bags": "xyz789", + "features_bags": "abc123", "format": 987, - "gender": "xyz789", - "gift_message_available": "xyz789", - "id": 987, + "gender": "abc123", + "gift_message_available": "abc123", + "id": 123, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "manufacturer": 123, "material": "abc123", "media_gallery": [MediaGalleryInterface], @@ -2220,56 +2224,56 @@ Defines basic features of a configurable product and its simple product variants "meta_keyword": "xyz789", "meta_title": "xyz789", "name": "xyz789", - "new": 987, + "new": 123, "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "pattern": "abc123", + "options_container": "abc123", + "pattern": "xyz789", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 123, + "purpose": 987, "rating_summary": 987.65, "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, + "relative_url": "xyz789", + "review_count": 123, "reviews": ProductReviews, "sale": 987, "short_description": ComplexTextValue, - "size": 123, - "sku": "abc123", - "sleeve": "abc123", + "size": 987, + "sku": "xyz789", + "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "xyz789", - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", - "staged": false, + "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "xyz789", - "style_bottom": "xyz789", - "style_general": "xyz789", - "swatch_image": "abc123", + "strap_bags": "xyz789", + "style_bags": "abc123", + "style_bottom": "abc123", + "style_general": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": "4", - "updated_at": "abc123", + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "variants": [ConfigurableVariant], "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -2283,8 +2287,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](types-q-s.md#string) | Deprecated. Use `CartItemInput.sku` instead. | #### Example @@ -2292,7 +2296,7 @@ Defines basic features of a configurable product and its simple product variants { "customizable_options": [CustomizableOptionInput], "data": CartItemInput, - "parent_sku": "xyz789", + "parent_sku": "abc123", "variant_sku": "xyz789" } ``` @@ -2307,18 +2311,18 @@ Contains details about configurable product options. | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](types-f-i.md#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, + "attribute_code": "abc123", + "label": "xyz789", + "uid": "4", "values": [ConfigurableProductOptionValue] } ``` @@ -2333,19 +2337,19 @@ Defines a value for a configurable product option. | 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. | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | #### Example ```json { - "is_available": true, + "is_available": false, "is_use_default": true, - "label": "abc123", + "label": "xyz789", "swatch": SwatchDataInterface, "uid": 4 } @@ -2361,31 +2365,31 @@ Defines configurable attributes for the specified 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](types-a-b.md#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_code": "abc123", "attribute_id": "xyz789", - "attribute_id_v2": 123, + "attribute_id_v2": 987, "attribute_uid": 4, "id": 123, "label": "xyz789", - "position": 123, + "position": 987, "product_id": 123, - "uid": "4", + "uid": 4, "use_default": true, "values": [ConfigurableProductOptionsValues] } @@ -2402,9 +2406,9 @@ Contains metadata corresponding to the selected configurable options. | 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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#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. | +| `variant` - [`SimpleProduct`](types-q-s.md#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 @@ -2429,21 +2433,21 @@ Contains the index number assigned to a configurable product option. | 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.)* | +| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "default_label": "abc123", - "label": "abc123", - "store_label": "abc123", + "default_label": "xyz789", + "label": "xyz789", + "store_label": "xyz789", "swatch_data": SwatchDataInterface, "uid": 4, "use_default_value": false, @@ -2461,11 +2465,11 @@ Contains details about configurable products added to a requisition list. | 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. | +| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2474,8 +2478,8 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" } ``` @@ -2490,7 +2494,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -2511,15 +2515,15 @@ A configurable product wish list 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -2531,7 +2535,7 @@ A configurable product wish list item. "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": "4", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -2547,12 +2551,12 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": [4]} +{"requisitionListItemUids": ["4"]} ``` @@ -2565,7 +2569,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -2583,9 +2587,9 @@ Contains the source and target wish lists after copying products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -2605,12 +2609,12 @@ Contains the source and target wish lists after copying products. | 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. | +| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example @@ -2619,8 +2623,8 @@ Contains the source and target wish lists after copying products. "available_regions": [Region], "full_name_english": "abc123", "full_name_locale": "xyz789", - "id": "xyz789", - "three_letter_abbreviation": "xyz789", + "id": "abc123", + "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "xyz789" } ``` @@ -2969,7 +2973,7 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example @@ -2987,14 +2991,14 @@ Defines a new gift registry. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3023,7 +3027,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3041,19 +3045,19 @@ Contains the secure information used to authorize transaction. Applies to Payflo | 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. | +| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { "response_message": "xyz789", - "result": 987, - "result_code": 987, + "result": 123, + "result_code": 123, "secure_token": "abc123", "secure_token_id": "abc123" } @@ -3069,21 +3073,21 @@ Defines a new product review. | 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. | +| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example ```json { - "nickname": "xyz789", + "nickname": "abc123", "ratings": [ProductReviewRatingInput], - "sku": "xyz789", - "summary": "abc123", - "text": "xyz789" + "sku": "abc123", + "summary": "xyz789", + "text": "abc123" } ``` @@ -3097,7 +3101,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | #### Example @@ -3116,7 +3120,7 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example @@ -3135,9 +3139,9 @@ Defines a set of conditions that apply to a rule. | 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. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -3146,7 +3150,7 @@ Defines a set of conditions that apply to a rule. "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, "attribute": "GRAND_TOTAL", "operator": "MORE_THAN", - "quantity": 123 + "quantity": 987 } ``` @@ -3160,15 +3164,15 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { - "description": "abc123", - "name": "abc123" + "description": "xyz789", + "name": "xyz789" } ``` @@ -3182,7 +3186,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -3200,13 +3204,13 @@ Defines the name and visibility of a new wish list. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json -{"name": "xyz789", "visibility": "PUBLIC"} +{"name": "abc123", "visibility": "PUBLIC"} ``` @@ -3219,7 +3223,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -3237,19 +3241,19 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | 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. | +| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | #### Example ```json { - "cc_exp_month": 123, + "cc_exp_month": 987, "cc_exp_year": 987, "cc_last_4": 987, - "cc_type": "abc123" + "cc_type": "xyz789" } ``` @@ -3263,10 +3267,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](types-f-i.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -3290,12 +3294,12 @@ Contains credit memo details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -3304,10 +3308,10 @@ Contains credit memo details. "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` @@ -3322,20 +3326,20 @@ Credit memo item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -3347,7 +3351,7 @@ Credit memo item details. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 987.65 } ``` @@ -3362,15 +3366,15 @@ Contains credit memo price details. | 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. | +| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](types-k-p.md#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. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -3396,13 +3400,13 @@ Contains credit memo price details. | 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 $. | +| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](types-q-s.md#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 @@ -3410,12 +3414,12 @@ Contains credit memo price details. ```json { "available_currency_codes": ["abc123"], - "base_currency_code": "xyz789", - "base_currency_symbol": "abc123", - "default_display_currecy_code": "xyz789", + "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": "abc123", + "default_display_currency_code": "xyz789", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } ``` @@ -3617,7 +3621,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | #### Example @@ -3636,48 +3640,48 @@ Defines the customer name, addresses, and other details. | 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. | +| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the account was created. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | Details about a specific gift registry. | +| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#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. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](types-q-s.md#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). | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#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 @@ -3686,30 +3690,30 @@ Defines the customer name, addresses, and other details. "addresses": [CustomerAddress], "allow_remote_shopping_assistance": true, "compare_list": CompareList, - "created_at": "xyz789", + "created_at": "abc123", "date_of_birth": "xyz789", - "default_billing": "xyz789", - "default_shipping": "xyz789", - "dob": "abc123", + "default_billing": "abc123", + "default_shipping": "abc123", + "dob": "xyz789", "email": "xyz789", - "firstname": "xyz789", - "gender": 987, + "firstname": "abc123", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group_id": 123, - "id": 987, + "id": 123, "is_subscribed": true, - "job_title": "abc123", - "lastname": "abc123", - "middlename": "abc123", + "job_title": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -3719,10 +3723,10 @@ Defines the customer name, addresses, and other details. "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -3739,54 +3743,54 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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.)* | +| `country_id` - [`String`](types-q-s.md#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. | +| `customer_id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#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. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "abc123", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], - "customer_id": 987, + "customer_id": 123, "default_billing": false, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "abc123", "id": 987, "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", + "region_id": 987, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", "vat_id": "xyz789" } ``` @@ -3801,14 +3805,14 @@ Specifies the attribute code and value of a customer address attribute. | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](types-q-s.md#string) | The valuue assigned to the customer address attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "abc123" } ``` @@ -3823,8 +3827,8 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | #### Example @@ -3845,37 +3849,37 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], - "default_billing": false, + "default_billing": true, "default_shipping": false, - "fax": "xyz789", + "fax": "abc123", "firstname": "xyz789", "lastname": "abc123", "middlename": "abc123", @@ -3884,8 +3888,8 @@ Contains details about a billing or shipping address. "region": CustomerAddressRegionInput, "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "abc123" + "telephone": "abc123", + "vat_id": "xyz789" } ``` @@ -3899,16 +3903,16 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "abc123", - "region_code": "xyz789", + "region": "xyz789", + "region_code": "abc123", "region_id": 987 } ``` @@ -3923,17 +3927,17 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "region": "abc123", - "region_code": "xyz789", - "region_id": 123 + "region_code": "abc123", + "region_id": 987 } ``` @@ -3947,37 +3951,37 @@ An input object for creating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "allow_remote_shopping_assistance": false, - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "dob": "abc123", "email": "abc123", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "is_subscribed": false, "lastname": "xyz789", "middlename": "abc123", "password": "abc123", "prefix": "xyz789", "suffix": "abc123", - "taxvat": "abc123" + "taxvat": "xyz789" } ``` @@ -3991,21 +3995,21 @@ Contains details about a single downloadable product. | 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`. | +| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "date": "abc123", + "date": "xyz789", "download_url": "xyz789", "order_increment_id": "abc123", - "remaining_downloads": "xyz789", - "status": "abc123" + "remaining_downloads": "abc123", + "status": "xyz789" } ``` @@ -4037,34 +4041,34 @@ An input object that assigns or updates customer attributes. | 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). | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "date_of_birth": "abc123", - "dob": "abc123", + "dob": "xyz789", "email": "abc123", "firstname": "xyz789", - "gender": 123, + "gender": 987, "is_subscribed": false, "lastname": "abc123", "middlename": "xyz789", - "password": "xyz789", + "password": "abc123", "prefix": "abc123", - "suffix": "xyz789", + "suffix": "abc123", "taxvat": "abc123" } ``` @@ -4079,31 +4083,31 @@ Contains details about each of the customer's orders. | 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.)* | +| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](types-q-s.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | +| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | +| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -4112,12 +4116,12 @@ Contains details about each of the customer's orders. "billing_address": OrderAddress, "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 987.65, + "grand_total": 123.45, "id": "4", "increment_id": "xyz789", "invoices": [Invoice], @@ -4131,7 +4135,7 @@ Contains details about each of the customer's orders. "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", + "shipping_method": "xyz789", "status": "xyz789", "total": OrderTotal } @@ -4147,7 +4151,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](types-q-s.md#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 @@ -4186,8 +4190,8 @@ The collection of orders that match the conditions defined in the filter. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | #### Example @@ -4209,7 +4213,7 @@ Identifies the filter to use for filtering orders. | Input Field | Description | |-------------|-------------| -| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | +| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | #### Example @@ -4245,7 +4249,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -4264,8 +4268,8 @@ Contains store credit information with balance and history. | 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. | +| `current_balance` - [`Money`](types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -4273,7 +4277,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -4288,8 +4292,8 @@ Lists changes to the amount of store credit available to the customer. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | #### Example @@ -4297,7 +4301,7 @@ Lists changes to the amount of store credit available to the customer. { "items": [CustomerStoreCreditHistoryItem], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -4311,10 +4315,10 @@ Contains store credit history information. | 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. | +| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | #### Example @@ -4323,7 +4327,7 @@ Contains store credit history information. "action": "xyz789", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "abc123" + "date_time_changed": "xyz789" } ``` @@ -4337,7 +4341,7 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | +| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | #### Example @@ -4355,17 +4359,17 @@ An input object for updating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -4373,14 +4377,14 @@ An input object for updating a customer. { "allow_remote_shopping_assistance": true, "date_of_birth": "xyz789", - "dob": "xyz789", - "firstname": "xyz789", + "dob": "abc123", + "firstname": "abc123", "gender": 987, "is_subscribed": true, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "prefix": "xyz789", - "suffix": "abc123", + "prefix": "abc123", + "suffix": "xyz789", "taxvat": "abc123" } ``` @@ -4395,12 +4399,12 @@ Contains information about a text area that is defined as part of a customizable | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example @@ -4409,10 +4413,10 @@ Contains information about a text area that is defined as part of a customizable { "option_id": 987, "product_sku": "abc123", - "required": true, - "sort_order": 987, - "title": "xyz789", - "uid": "4", + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": 4, "value": CustomizableAreaValue } ``` @@ -4427,21 +4431,21 @@ Defines the price and sku of a product whose page contains a customized text are | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "max_characters": 987, - "price": 123.45, + "max_characters": 123, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", - "uid": "4" + "sku": "xyz789", + "uid": 4 } ``` @@ -4455,22 +4459,22 @@ Contains information about a set of checkbox values that are defined as part of | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 987, "required": false, "sort_order": 987, "title": "abc123", - "uid": "4", + "uid": 4, "value": [CustomizableCheckboxValue] } ``` @@ -4485,25 +4489,25 @@ Defines the price and sku of a product whose page contains a customized set of c | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, + "sku": "abc123", + "sort_order": 987, "title": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -4517,21 +4521,21 @@ Contains information about a date picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": 123, + "option_id": 987, "product_sku": "abc123", - "required": false, + "required": true, "sort_order": 123, "title": "abc123", "uid": "4", @@ -4569,11 +4573,11 @@ Defines the price and sku of a product whose page contains a customized date pic | 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. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example @@ -4583,7 +4587,7 @@ Defines the price and sku of a product whose page contains a customized date pic "price_type": "FIXED", "sku": "abc123", "type": "DATE", - "uid": "4" + "uid": 4 } ``` @@ -4597,19 +4601,19 @@ Contains information about a drop down menu that is defined as part of a customi | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 123, + "required": false, "sort_order": 123, "title": "xyz789", "uid": "4", @@ -4627,13 +4631,13 @@ Defines the price and sku of a product whose page contains a customized drop dow | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example @@ -4642,10 +4646,10 @@ Defines the price and sku of a product whose page contains a customized drop dow "option_type_id": 987, "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "sort_order": 123, - "title": "xyz789", - "uid": 4 + "title": "abc123", + "uid": "4" } ``` @@ -4659,12 +4663,12 @@ Contains information about a text field that is defined as part of a customizabl | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example @@ -4675,7 +4679,7 @@ Contains information about a text field that is defined as part of a customizabl "product_sku": "abc123", "required": false, "sort_order": 987, - "title": "xyz789", + "title": "abc123", "uid": "4", "value": CustomizableFieldValue } @@ -4691,20 +4695,20 @@ Defines the price and sku of a product whose page contains a customized text fie | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { "max_characters": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "uid": 4 } ``` @@ -4719,12 +4723,12 @@ Contains information about a file picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -4751,21 +4755,21 @@ Defines the price and sku of a product whose page contains a customized file pic | 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. | +| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "file_extension": "xyz789", - "image_size_x": 987, - "image_size_y": 987, + "file_extension": "abc123", + "image_size_x": 123, + "image_size_y": 123, "price": 987.65, "price_type": "FIXED", "sku": "abc123", @@ -4783,22 +4787,22 @@ Contains information about a multiselect that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 987, "required": false, "sort_order": 987, - "title": "abc123", - "uid": 4, + "title": "xyz789", + "uid": "4", "value": [CustomizableMultipleValue] } ``` @@ -4813,24 +4817,24 @@ Defines the price and sku of a product whose page contains a customized multisel | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { - "option_type_id": 987, - "price": 987.65, + "option_type_id": 123, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", - "sort_order": 987, - "title": "xyz789", + "sort_order": 123, + "title": "abc123", "uid": 4 } ``` @@ -4845,13 +4849,13 @@ Defines a customizable option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int`](#int) | The customizable option ID of the product. | -| `value_string` - [`String!`](#string) | The string value of the option. | +| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | +| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | #### Example ```json -{"id": 123, "value_string": "xyz789"} +{"id": 123, "value_string": "abc123"} ``` @@ -4864,11 +4868,11 @@ Contains basic information about a customizable option. It can be implemented by | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -4911,11 +4915,11 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | | [`ConfigurableProduct`](#configurableproduct) | #### Example @@ -4934,11 +4938,11 @@ Contains information about a set of radio buttons that are defined as part of a | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example @@ -4946,7 +4950,7 @@ Contains information about a set of radio buttons that are defined as part of a ```json { "option_id": 123, - "required": true, + "required": false, "sort_order": 123, "title": "abc123", "uid": 4, @@ -4964,25 +4968,25 @@ Defines the price and sku of a product whose page contains a customized set of r | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { "option_type_id": 123, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "xyz789", "sort_order": 123, - "title": "xyz789", - "uid": 4 + "title": "abc123", + "uid": "4" } ``` @@ -4996,7 +5000,7 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example @@ -5014,12 +5018,12 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -5032,7 +5036,7 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example @@ -5050,7 +5054,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -5066,9 +5070,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -5087,7 +5091,7 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -5106,7 +5110,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -5123,12 +5127,12 @@ NegotiableQuoteUidOperationSuccess | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -5141,9 +5145,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -5168,7 +5172,7 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example @@ -5189,13 +5193,13 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | +| `message` - [`String`](types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"message": "xyz789", "type": "UNDEFINED"} +{"message": "abc123", "type": "UNDEFINED"} ``` @@ -5225,12 +5229,12 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example ```json -{"approval_rule_uids": [4]} +{"approval_rule_uids": ["4"]} ``` @@ -5261,7 +5265,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -5279,13 +5283,13 @@ Indicates whether the request to delete the requisition list was successful. | 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. | +| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example ```json -{"requisition_lists": RequisitionLists, "status": true} +{"requisition_lists": RequisitionLists, "status": false} ``` @@ -5298,13 +5302,13 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"status": true, "wishlists": [Wishlist]} +{"status": false, "wishlists": [Wishlist]} ``` @@ -5317,8 +5321,8 @@ Defines an individual discount. A discount can be applied to the cart as a whole | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | -| `label` - [`String!`](#string) | A description of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | #### Example @@ -5339,15 +5343,15 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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.)* | +| `id` - [`String!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -5355,13 +5359,13 @@ An implementation for downloadable product cart items. { "customizable_options": [SelectedCustomizableOption], "errors": [CartItemError], - "id": "abc123", + "id": "xyz789", "links": [DownloadableProductLinks], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -5377,12 +5381,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -5390,11 +5394,11 @@ Defines downloadable product options for `CreditMemoItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 } ``` @@ -5428,12 +5432,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -5441,12 +5445,12 @@ Defines downloadable product options for `InvoiceItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -5460,9 +5464,9 @@ Defines characteristics of the links for downloadable product. | 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. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example @@ -5470,7 +5474,7 @@ Defines characteristics of the links for downloadable product. { "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5486,24 +5490,24 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -5511,24 +5515,24 @@ Defines downloadable product options for `OrderItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "abc123", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, + "quantity_invoiced": 987.65, "quantity_ordered": 123.45, "quantity_refunded": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -5542,102 +5546,102 @@ Defines a product that the shopper downloads. | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#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 | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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.)* | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](types-f-i.md#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", +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "abc123", + "category_gear": "xyz789", "climate": "abc123", "collar": "abc123", "color": 123, "country_of_manufacture": "abc123", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, "downloadable_product_links": [ @@ -5648,70 +5652,70 @@ Defines a product that the shopper downloads. ], "eco_collection": 987, "erin_recommends": 987, - "features_bags": "xyz789", + "features_bags": "abc123", "format": 987, "gender": "abc123", "gift_message_available": "xyz789", "id": 987, "image": ProductImage, "is_returnable": "xyz789", - "links_purchased_separately": 123, + "links_purchased_separately": 987, "links_title": "xyz789", - "manufacturer": 123, - "material": "xyz789", + "manufacturer": 987, + "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", "name": "xyz789", "new": 987, "new_from_date": "xyz789", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "xyz789", - "performance_fabric": 987, + "options_container": "xyz789", + "pattern": "abc123", + "performance_fabric": 123, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 987, - "rating_summary": 123.45, + "rating_summary": 987.65, "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "sale": 123, "short_description": ComplexTextValue, "size": 123, - "sku": "abc123", - "sleeve": "xyz789", + "sku": "xyz789", + "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 123.45, - "special_to_date": "xyz789", + "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", "strap_bags": "xyz789", - "style_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "xyz789", "style_general": "abc123", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", - "uid": "4", - "updated_at": "abc123", + "type_id": "xyz789", + "uid": 4, + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website] } ``` @@ -5752,32 +5756,32 @@ Defines characteristics of a downloadable product. | 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.)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](types-a-b.md#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)* | +| `number_of_downloads` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { "id": 123, - "is_shareable": true, + "is_shareable": false, "link_type": "FILE", "number_of_downloads": 987, - "price": 987.65, - "sample_file": "abc123", + "price": 123.45, + "sample_file": "xyz789", "sample_type": "FILE", "sample_url": "abc123", "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": "4" } ``` @@ -5792,12 +5796,12 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example ```json -{"link_id": 987} +{"link_id": 123} ``` @@ -5810,19 +5814,19 @@ Defines characteristics of a downloadable product. | 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)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | #### Example ```json { - "id": 987, - "sample_file": "xyz789", + "id": 123, + "sample_file": "abc123", "sample_type": "FILE", "sample_url": "abc123", "sort_order": 987, @@ -5840,12 +5844,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -5870,23 +5874,23 @@ A downloadable product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": "4", + "id": 4, "links_v2": [DownloadableProductLinks], "product": ProductInterface, "quantity": 123.45, @@ -5905,7 +5909,7 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example @@ -5969,8 +5973,8 @@ Contains an array of dynamic blocks. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -5992,7 +5996,7 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](types-f-i.md#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. | @@ -6012,15 +6016,15 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | +| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | #### Example ```json { - "attribute_code": "abc123", - "value": "xyz789" + "attribute_code": "xyz789", + "value": "abc123" } ``` @@ -6034,8 +6038,8 @@ Defines a customer-entered option. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | #### Example @@ -6056,22 +6060,22 @@ Contains the `uid`, `relative_url`, and `type` attributes. | 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. | +| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { "canonical_url": "abc123", - "entity_uid": "4", - "id": 123, - "redirectCode": 123, - "relative_url": "abc123", + "entity_uid": 4, + "id": 987, + "redirectCode": 987, + "relative_url": "xyz789", "type": "CMS_PAGE" } ``` @@ -6084,15 +6088,15 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | #### Example @@ -6110,13 +6114,13 @@ Lists the exchange rate. | 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. | +| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "abc123", "rate": 987.65} +{"currency_to": "xyz789", "rate": 987.65} ``` @@ -6129,10 +6133,10 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` 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 34f9aa923..0aa1d13fb 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 @@ -8,8 +8,8 @@ Defines a filter that matches the input exactly. | 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"]`. | +| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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 @@ -30,12 +30,12 @@ Defines a filter that performs a fuzzy search. | 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`. | +| `match` - [`String`](types-q-s.md#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"} +{"match": "abc123"} ``` @@ -48,15 +48,15 @@ Defines a filter that matches a range of values, such as prices or dates. | 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. | +| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example ```json { "from": "xyz789", - "to": "xyz789" + "to": "abc123" } ``` @@ -70,9 +70,9 @@ Defines a filter for an input string. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example @@ -80,7 +80,7 @@ Defines a filter for an input string. { "eq": "abc123", "in": ["abc123"], - "match": "xyz789" + "match": "abc123" } ``` @@ -94,41 +94,41 @@ Defines the comparison operators that can be used in a filter. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](types-q-s.md#string) | | +| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](types-q-s.md#string) | Less than. | +| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](types-q-s.md#string) | Not null. | +| `null` - [`String`](types-q-s.md#string) | Is null. | +| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { - "eq": "xyz789", + "eq": "abc123", "finset": ["xyz789"], "from": "xyz789", "gt": "xyz789", "gteq": "abc123", - "in": ["abc123"], + "in": ["xyz789"], "like": "xyz789", "lt": "xyz789", "lteq": "abc123", "moreq": "abc123", "neq": "abc123", - "nin": ["xyz789"], - "notnull": "abc123", - "null": "abc123", - "to": "xyz789" + "nin": ["abc123"], + "notnull": "xyz789", + "null": "xyz789", + "to": "abc123" } ``` @@ -142,15 +142,15 @@ A single FPT that can be applied to a product price. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example ```json { "amount": Money, - "label": "abc123" + "label": "xyz789" } ``` @@ -200,7 +200,7 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example @@ -218,12 +218,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | +| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "abc123"} +{"customer_token": "xyz789"} ``` @@ -236,16 +236,16 @@ Contains details about the gift card account. | 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. | +| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "abc123" } ``` @@ -260,7 +260,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | #### Example @@ -291,10 +291,10 @@ Contains the value of a gift card, the website that generated the card, and rela { "attribute_id": 987, "uid": 4, - "value": 987.65, + "value": 123.45, "value_id": 123, - "website_id": 987, - "website_value": 987.65 + "website_id": 123, + "website_value": 123.45 } ``` @@ -308,18 +308,18 @@ Contains details about a gift card that has been added to a cart. | 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. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount and currency of the gift card. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#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. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -334,11 +334,11 @@ Contains details about a gift card that has been added to a cart. "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "recipient_email": "abc123", + "recipient_email": "xyz789", "recipient_name": "abc123", "sender_email": "xyz789", - "sender_name": "xyz789", - "uid": 4 + "sender_name": "abc123", + "uid": "4" } ``` @@ -350,13 +350,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -370,7 +370,7 @@ Contains details about a gift card that has been added to a cart. "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } ``` @@ -382,13 +382,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -399,7 +399,7 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "quantity_invoiced": 123.45 @@ -416,20 +416,20 @@ Contains details about a gift card. | 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. | +| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](types-q-s.md#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", + "message": "abc123", + "recipient_email": "abc123", + "recipient_name": "xyz789", + "sender_email": "xyz789", "sender_name": "abc123" } ``` @@ -444,13 +444,13 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -459,10 +459,10 @@ Contains details about the sender, recipient, and amount of a gift card. "amount": Money, "custom_giftcard_amount": Money, "message": "abc123", - "recipient_email": "xyz789", + "recipient_email": "abc123", "recipient_name": "xyz789", - "sender_email": "xyz789", - "sender_name": "xyz789" + "sender_email": "abc123", + "sender_name": "abc123" } ``` @@ -474,26 +474,26 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#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. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#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. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -505,20 +505,20 @@ Contains details about the sender, recipient, and amount of a gift card. "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "xyz789", "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 123.45, "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -532,93 +532,93 @@ Defines properties of a gift card. | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](types-a-b.md#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.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `features_bags` - [`String`](types-q-s.md#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. | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`String`](types-q-s.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](types-q-s.md#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.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#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. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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.)* | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#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. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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 @@ -626,24 +626,24 @@ Defines properties of a gift card. ```json { "activity": "xyz789", - "allow_message": false, + "allow_message": true, "allow_open_amount": false, "attribute_set_id": 123, - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "xyz789", + "category_gear": "abc123", "climate": "abc123", - "collar": "abc123", + "collar": "xyz789", "color": 987, "country_of_manufacture": "abc123", "created_at": "xyz789", "crosssell_products": [ProductInterface], "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 123, + "eco_collection": 987, + "erin_recommends": 987, "features_bags": "xyz789", "format": 123, - "gender": "abc123", + "gender": "xyz789", "gift_card_options": [CustomizableOptionInterface], "gift_message_available": "xyz789", "giftcard_amounts": [GiftCardAmounts], @@ -659,18 +659,18 @@ Defines properties of a gift card. "media_gallery_entries": [MediaGalleryEntry], "message_max_length": 123, "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", - "name": "xyz789", - "new": 987, + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "name": "abc123", + "new": 123, "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, + "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": "xyz789", - "pattern": "xyz789", + "options_container": "abc123", + "pattern": "abc123", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, @@ -678,37 +678,37 @@ Defines properties of a gift card. "product_links": [ProductLinksInterface], "purpose": 987, "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, + "relative_url": "xyz789", + "review_count": 123, "reviews": ProductReviews, - "sale": 987, + "sale": 123, "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, + "special_price": 987.65, + "special_to_date": "abc123", + "staged": true, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "xyz789", + "style_bags": "abc123", "style_bottom": "abc123", "style_general": "abc123", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", "uid": "4", - "updated_at": "abc123", + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], @@ -726,9 +726,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -754,10 +754,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -765,11 +765,11 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_shipped": 123.45 } ``` @@ -804,12 +804,12 @@ A single gift card added to a wish list. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -822,7 +822,7 @@ A single gift card added to a wish list. "gift_card_options": GiftCardOptions, "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -836,15 +836,15 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | +| `from` - [`String!`](types-q-s.md#string) | Sender name | +| `message` - [`String!`](types-q-s.md#string) | Gift message text | +| `to` - [`String!`](types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "abc123", + "from": "xyz789", "message": "xyz789", "to": "abc123" } @@ -860,16 +860,16 @@ Defines a gift message. | 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. | +| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | #### Example ```json { "from": "xyz789", - "message": "xyz789", + "message": "abc123", "to": "abc123" } ``` @@ -884,9 +884,9 @@ Contains prices for gift wrapping options. | 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. | +| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | #### Example @@ -908,15 +908,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `event_name` - [`String!`](types-q-s.md#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. | +| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](types-q-s.md#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. | +| `shipping_address` - [`CustomerAddress`](types-c-e.md#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. | @@ -927,16 +927,16 @@ Contains details about a gift registry. { "created_at": "xyz789", "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "xyz789", + "message": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } ``` @@ -950,8 +950,8 @@ Contains details about a gift registry. |------------|-------------| | `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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example @@ -960,7 +960,7 @@ Contains details about a gift registry. "code": "4", "group": "EVENT_INFORMATION", "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -998,7 +998,7 @@ Defines a dynamic attribute. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example @@ -1018,8 +1018,8 @@ Defines a dynamic attribute. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1046,11 +1046,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Example @@ -1059,10 +1059,10 @@ Defines a dynamic attribute. { "attribute_group": "xyz789", "code": 4, - "input_type": "abc123", - "is_required": true, - "label": "xyz789", - "sort_order": 987 + "input_type": "xyz789", + "is_required": false, + "label": "abc123", + "sort_order": 123 } ``` @@ -1074,11 +1074,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1091,12 +1091,12 @@ Defines a dynamic attribute. ```json { - "attribute_group": "xyz789", - "code": "4", + "attribute_group": "abc123", + "code": 4, "input_type": "abc123", - "is_required": false, - "label": "xyz789", - "sort_order": 123 + "is_required": true, + "label": "abc123", + "sort_order": 987 } ``` @@ -1108,9 +1108,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1120,11 +1120,11 @@ Defines a dynamic attribute. ```json { "created_at": "abc123", - "note": "abc123", + "note": "xyz789", "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 987.65, - "uid": "4" + "quantity": 987.65, + "quantity_fulfilled": 123.45, + "uid": 4 } ``` @@ -1136,9 +1136,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1153,12 +1153,12 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", + "created_at": "xyz789", "note": "abc123", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 987.65, - "uid": "4" + "quantity_fulfilled": 123.45, + "uid": 4 } ``` @@ -1172,14 +1172,14 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](types-a-b.md#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) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1203,7 +1203,7 @@ Contains details about an error that occurred when processing a gift registry it | `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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1211,10 +1211,10 @@ Contains details about an error that occurred when processing a gift registry it ```json { "code": "OUT_OF_STOCK", - "gift_registry_item_uid": "4", + "gift_registry_item_uid": 4, "gift_registry_uid": 4, - "message": "xyz789", - "product_uid": 4 + "message": "abc123", + "product_uid": "4" } ``` @@ -1254,7 +1254,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1292,9 +1292,9 @@ Contains details about a registrant. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1304,10 +1304,10 @@ Contains details about a registrant. "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "lastname": "xyz789", - "uid": "4" + "lastname": "abc123", + "uid": 4 } ``` @@ -1320,8 +1320,8 @@ Contains details about a registrant. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example @@ -1329,7 +1329,7 @@ Contains details about a registrant. { "code": "4", "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1343,12 +1343,12 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | +| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](types-q-s.md#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. | +| `location` - [`String`](types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](types-q-s.md#string) | The type of event being held. | #### Example @@ -1357,9 +1357,9 @@ Contains the results of a gift registry search. "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": "4", - "location": "xyz789", + "location": "abc123", "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ``` @@ -1373,7 +1373,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | Defines the shipping address for this gift registry. | | `address_id` - [`ID`](#id) | The ID assigned to this customer address. | #### Example @@ -1412,7 +1412,7 @@ Contains details about a gift registry type. | 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. | +| `label` - [`String!`](types-q-s.md#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 @@ -1423,7 +1423,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1437,18 +1437,18 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `design` - [`String!`](types-q-s.md#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. | +| `price` - [`Money!`](types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example ```json { - "design": "abc123", - "id": 4, + "design": "xyz789", + "id": "4", "image": GiftWrappingImage, "price": Money, "uid": "4" @@ -1465,8 +1465,8 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | #### Example @@ -1487,83 +1487,83 @@ Defines a grouped product, which consists of simple standalone products that are | Field Name | Description | |------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `activity` - [`String`](types-q-s.md#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.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `features_bags` - [`String`](types-q-s.md#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. | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](types-q-s.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#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. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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.)* | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#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. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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 @@ -1571,68 +1571,68 @@ Defines a grouped product, which consists of simple standalone products that are ```json { "activity": "xyz789", - "attribute_set_id": 123, - "canonical_url": "xyz789", + "attribute_set_id": 987, + "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "abc123", - "climate": "abc123", + "climate": "xyz789", "collar": "abc123", - "color": 987, + "color": 123, "country_of_manufacture": "xyz789", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, "eco_collection": 987, - "erin_recommends": 123, - "features_bags": "xyz789", - "format": 123, + "erin_recommends": 987, + "features_bags": "abc123", + "format": 987, "gender": "abc123", "gift_message_available": "abc123", - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", "items": [GroupedProductItem], - "manufacturer": 123, - "material": "abc123", + "manufacturer": 987, + "material": "xyz789", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", - "name": "xyz789", + "name": "abc123", "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, + "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, + "purpose": 123, "rating_summary": 987.65, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, + "relative_url": "xyz789", + "review_count": 123, "reviews": ProductReviews, - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, - "size": 987, - "sku": "xyz789", + "size": 123, + "sku": "abc123", "sleeve": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "xyz789", - "staged": false, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "abc123", + "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "abc123", + "strap_bags": "xyz789", + "style_bags": "xyz789", "style_bottom": "abc123", - "style_general": "xyz789", + "style_general": "abc123", "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, @@ -1640,9 +1640,9 @@ Defines a grouped product, which consists of simple standalone products that are "type": "CMS_PAGE", "type_id": "abc123", "uid": "4", - "updated_at": "abc123", + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", @@ -1662,7 +1662,7 @@ Contains information about an individual grouped product item. | 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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example @@ -1671,7 +1671,7 @@ Contains information about an individual grouped product item. { "position": 987, "product": ProductInterface, - "qty": 987.65 + "qty": 123.45 } ``` @@ -1685,11 +1685,11 @@ A grouped product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -1701,7 +1701,7 @@ A grouped product wish list item. "description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1715,14 +1715,14 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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", + "cancel_url": "abc123", "return_url": "xyz789" } ``` @@ -1737,7 +1737,7 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | #### Example @@ -1755,7 +1755,7 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example @@ -1773,15 +1773,15 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | +| `name` - [`String`](types-q-s.md#string) | A parameter name. | +| `value` - [`String`](types-q-s.md#string) | A parameter value. | #### Example ```json { - "name": "xyz789", - "value": "xyz789" + "name": "abc123", + "value": "abc123" } ``` @@ -1809,15 +1809,15 @@ When expected as an input type, any string (such as `"4"`) or integer | 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. | +| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json { "thumbnail": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -1844,7 +1844,7 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example @@ -1862,10 +1862,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#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. | +| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -1875,7 +1875,7 @@ Contains invoice details. "comments": [SalesCommentItem], "id": "4", "items": [InvoiceItemInterface], - "number": "xyz789", + "number": "abc123", "total": InvoiceTotal } ``` @@ -1888,12 +1888,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -1901,9 +1901,9 @@ Contains invoice details. ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_invoiced": 987.65 @@ -1920,20 +1920,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -1944,7 +1944,7 @@ Contains detailes about invoiced items. "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "quantity_invoiced": 123.45 @@ -1961,14 +1961,14 @@ Contains price details from an invoice. | 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. | +| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -1995,12 +1995,12 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2013,7 +2013,7 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example @@ -2031,7 +2031,7 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example @@ -2049,12 +2049,12 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2067,12 +2067,12 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2086,7 +2086,7 @@ A list of options of the selected bundle product. | 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. | +| `label` - [`String!`](types-q-s.md#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. | @@ -2094,8 +2094,8 @@ A list of options of the selected bundle product. ```json { - "id": "4", - "label": "xyz789", + "id": 4, + "label": "abc123", "uid": "4", "values": [ItemSelectedBundleOptionValue] } @@ -2112,9 +2112,9 @@ A list of values for the selected bundle product. | 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. | +| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](types-q-s.md#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. | @@ -2125,7 +2125,7 @@ A list of values for the selected bundle product. "id": 4, "price": Money, "product_name": "abc123", - "product_sku": "xyz789", + "product_sku": "abc123", "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 index 9f33cf2f5..13e7307b2 100644 --- 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 @@ -8,15 +8,15 @@ Contains a key-value pair. | 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. | +| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | #### Example ```json { - "name": "abc123", - "value": "abc123" + "name": "xyz789", + "value": "xyz789" } ``` @@ -31,9 +31,9 @@ Contains information for rendering layered navigation. | 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.)* | +| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | #### Example @@ -42,7 +42,7 @@ Contains information for rendering layered navigation. "filter_items": [LayerFilterItemInterface], "filter_items_count": 123, "name": "abc123", - "request_var": "abc123" + "request_var": "xyz789" } ``` @@ -54,9 +54,9 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example @@ -76,16 +76,16 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#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) | +| [`SwatchLayerFilterItem`](types-q-s.md#swatchlayerfilteritem) | #### Example @@ -108,14 +108,14 @@ Defines characteristics about images and videos associated with a specific produ | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -126,11 +126,11 @@ Defines characteristics about images and videos associated with a specific produ "disabled": true, "file": "abc123", "id": 123, - "label": "abc123", + "label": "xyz789", "media_type": "abc123", "position": 987, - "types": ["xyz789"], - "uid": 4, + "types": ["abc123"], + "uid": "4", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -145,10 +145,10 @@ Contains basic information about a product image or video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -161,10 +161,10 @@ Contains basic information about a product image or video. ```json { - "disabled": false, - "label": "xyz789", - "position": 123, - "url": "abc123" + "disabled": true, + "label": "abc123", + "position": 987, + "url": "xyz789" } ``` @@ -178,13 +178,13 @@ Defines a monetary value, including a numeric value and a currency code. | 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. | +| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | #### Example ```json -{"currency": "AFN", "value": 987.65} +{"currency": "AFN", "value": 123.45} ``` @@ -197,9 +197,9 @@ Contains the customer's gift registry and any errors encountered. | 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. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -221,7 +221,7 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example @@ -239,8 +239,8 @@ Output of the request to move items to another requisition list. | 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. | +| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -261,9 +261,9 @@ Contains the source and target wish lists after moving products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -285,23 +285,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](types-q-s.md#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. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#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. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -311,8 +311,8 @@ Contains details about a negotiable quote. "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "email": "abc123", + "created_at": "abc123", + "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_virtual": false, "items": [CartItemInterface], @@ -322,8 +322,8 @@ Contains details about a negotiable quote. "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", "total_quantity": 123.45, - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } ``` @@ -337,8 +337,8 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | +| `code` - [`String!`](types-q-s.md#string) | The address country code. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | #### Example @@ -359,33 +359,33 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example ```json { "city": "abc123", - "company": "xyz789", - "country_code": "xyz789", + "company": "abc123", + "country_code": "abc123", "firstname": "abc123", "lastname": "abc123", "postcode": "xyz789", "region": "xyz789", - "region_id": 987, - "save_in_address_book": true, + "region_id": 123, + "save_in_address_book": false, "street": ["abc123"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -397,15 +397,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -421,12 +421,12 @@ Defines the billing or shipping address to be applied to the cart. "city": "xyz789", "company": "xyz789", "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["xyz789"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -440,17 +440,17 @@ Defines the company's state or province. | 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. | +| `code` - [`String`](types-q-s.md#string) | The address region code. | +| `label` - [`String`](types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "xyz789", - "label": "xyz789", - "region_id": 123 + "code": "abc123", + "label": "abc123", + "region_id": 987 } ``` @@ -462,29 +462,29 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", "lastname": "xyz789", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -499,17 +499,17 @@ Defines the billing address. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#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, + "customer_address_uid": "4", + "same_as_shipping": true, "use_for_shipping": true } ``` @@ -525,10 +525,10 @@ Contains a single plain text comment from either the buyer or seller. | 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. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example @@ -537,7 +537,7 @@ Contains a single plain text comment from either the buyer or seller. "author": NegotiableQuoteUser, "created_at": "abc123", "creator_type": "BUYER", - "text": "abc123", + "text": "xyz789", "uid": "4" } ``` @@ -569,7 +569,7 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | +| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | #### Example @@ -587,9 +587,9 @@ Contains custom log entries added by third-party extensions. | 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. | +| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | #### Example @@ -597,7 +597,7 @@ Contains custom log entries added by third-party extensions. { "new_value": "abc123", "old_value": "abc123", - "title": "xyz789" + "title": "abc123" } ``` @@ -611,8 +611,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -663,12 +663,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "abc123"} +{"comment": "xyz789"} ``` @@ -684,8 +684,8 @@ Contains details about a change for a negotiable quote. | `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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -728,15 +728,15 @@ Contains a new expiration date and the previous date. | 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. | +| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "new_expiration": "abc123", - "old_expiration": "xyz789" + "new_expiration": "xyz789", + "old_expiration": "abc123" } ``` @@ -750,7 +750,7 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#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 @@ -831,7 +831,7 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example @@ -849,13 +849,13 @@ Specifies the updated quantity of an item. | 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. | +| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -{"quantity": 987.65, "quote_item_uid": "4"} +{"quantity": 987.65, "quote_item_uid": 4} ``` @@ -868,14 +868,14 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "purchase_order_number": "xyz789" } ``` @@ -888,17 +888,17 @@ Defines the payment method to be applied to the negotiable quote. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `selected_shipping_method` - [`SelectedShippingMethod`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example @@ -913,7 +913,7 @@ Defines the payment method to be applied to the negotiable quote. "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], + "street": ["xyz789"], "telephone": "abc123" } ``` @@ -929,8 +929,8 @@ Defines shipping addresses for the negotiable quote. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example @@ -938,7 +938,7 @@ Defines shipping addresses for the negotiable quote. { "address": NegotiableQuoteAddressInput, "customer_address_uid": "4", - "customer_notes": "xyz789" + "customer_notes": "abc123" } ``` @@ -952,7 +952,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1010,7 +1010,7 @@ Defines the field to use to sort a list of negotiable quotes. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1034,12 +1034,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1052,15 +1052,15 @@ A limited view of a Buyer or Seller in the negotiable quote process. | 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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | #### Example ```json { - "firstname": "abc123", - "lastname": "xyz789" + "firstname": "xyz789", + "lastname": "abc123" } ``` @@ -1075,9 +1075,9 @@ Contains a list of negotiable that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1100,8 +1100,8 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example @@ -1122,15 +1122,15 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json { - "order_id": "abc123", - "order_number": "xyz789" + "order_id": "xyz789", + "order_number": "abc123" } ``` @@ -1144,40 +1144,40 @@ Contains detailed information about an order's billing and shipping addresses. | 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). | +| `city` - [`String!`](types-q-s.md#string) | The city or town. | +| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | +| `fax` - [`String`](types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", "fax": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": "abc123", - "region_id": 4, + "region_id": "4", "street": ["xyz789"], "suffix": "abc123", - "telephone": "abc123", + "telephone": "xyz789", "vat_id": "abc123" } ``` @@ -1190,46 +1190,46 @@ Contains detailed information about an order's billing and shipping addresses. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example ```json { "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "abc123", - "quantity_canceled": 123.45, + "quantity_canceled": 987.65, "quantity_invoiced": 123.45, "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_returned": 123.45, + "quantity_refunded": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" @@ -1246,33 +1246,33 @@ Order item details. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | +| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | +| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1280,18 +1280,18 @@ Order item details. ```json { "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "abc123", "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, "quantity_ordered": 987.65, "quantity_refunded": 987.65, "quantity_returned": 987.65, @@ -1311,14 +1311,14 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | +| `label` - [`String!`](types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -1334,15 +1334,15 @@ Contains details about the payment method used to pay for the order. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example ```json { "additional_data": [KeyValue], - "name": "xyz789", + "name": "abc123", "type": "abc123" } ``` @@ -1357,20 +1357,20 @@ Contains order shipment details. | 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. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example ```json { "comments": [SalesCommentItem], - "id": "4", + "id": 4, "items": [ShipmentItemInterface], - "number": "xyz789", + "number": "abc123", "tracking": [ShipmentTracking] } ``` @@ -1386,11 +1386,11 @@ Contains details about the sales total amounts used to calculate the final price | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#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. | @@ -1421,15 +1421,15 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { - "payer_id": "abc123", - "token": "xyz789" + "payer_id": "xyz789", + "token": "abc123" } ``` @@ -1443,15 +1443,15 @@ A set of relative URLs that PayPal uses in response to various actions during th | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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", + "cancel_url": "xyz789", "error_url": "xyz789", "return_url": "xyz789" } @@ -1487,18 +1487,18 @@ Contains information used to generate PayPal iframe for transaction. Applies to | 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. | +| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example ```json { "mode": "TEST", - "paypal_url": "xyz789", - "secure_token": "abc123", - "secure_token_id": "abc123" + "paypal_url": "abc123", + "secure_token": "xyz789", + "secure_token_id": "xyz789" } ``` @@ -1512,12 +1512,12 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -1530,15 +1530,15 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | 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. | +| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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 + "is_active_payment_token_enabler": false } ``` @@ -1552,15 +1552,15 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | #### Example ```json { - "cart_id": "xyz789", - "paypal_payload": "xyz789" + "cart_id": "abc123", + "paypal_payload": "abc123" } ``` @@ -1572,7 +1572,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -1590,7 +1590,7 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | | `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example @@ -1612,16 +1612,16 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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", + "cancel_url": "abc123", + "error_url": "xyz789", "return_url": "xyz789" } ``` @@ -1636,16 +1636,16 @@ Defines the payment method. | 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. | +| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | +| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](types-f-i.md#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. | +| `payflowpro_cc_vault` - [`VaultTokenInput`](types-t-z.md#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. | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -1653,7 +1653,7 @@ Defines the payment method. { "braintree": BraintreeInput, "braintree_cc_vault": BraintreeCcVaultInput, - "code": "abc123", + "code": "xyz789", "hosted_pro": HostedProInput, "payflow_express": PayflowExpressInput, "payflow_link": PayflowLinkInput, @@ -1674,18 +1674,18 @@ The stored payment method available to the customer. | 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. | +| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](types-q-s.md#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", + "details": "abc123", + "payment_method_code": "xyz789", + "public_hash": "xyz789", "type": "card" } ``` @@ -1719,15 +1719,15 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { - "payer_id": "xyz789", - "token": "abc123" + "payer_id": "abc123", + "token": "xyz789" } ``` @@ -1741,19 +1741,19 @@ Defines the attributes required to receive a payment token for Express Checkout | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](types-a-b.md#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. | +| `use_paypal_credit` - [`Boolean`](types-a-b.md#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, + "code": "xyz789", + "express_button": true, "urls": PaypalExpressUrlsInput, "use_paypal_credit": true } @@ -1770,14 +1770,14 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | 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. | +| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | #### Example ```json { "paypal_urls": PaypalExpressUrlList, - "token": "abc123" + "token": "xyz789" } ``` @@ -1791,15 +1791,15 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | 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. | +| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | #### Example ```json { - "edit": "xyz789", - "start": "abc123" + "edit": "abc123", + "start": "xyz789" } ``` @@ -1813,17 +1813,17 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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", + "pending_url": "xyz789", "return_url": "abc123", "success_url": "abc123" } @@ -1839,22 +1839,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](types-f-i.md#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) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | #### Example ```json -{"weight": 987.65} +{"weight": 123.45} ``` @@ -1867,21 +1867,21 @@ Defines Pickup Location information. | 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) | | +| `city` - [`String`](types-q-s.md#string) | | +| `contact_name` - [`String`](types-q-s.md#string) | | +| `country_id` - [`String`](types-q-s.md#string) | | +| `description` - [`String`](types-q-s.md#string) | | +| `email` - [`String`](types-q-s.md#string) | | +| `fax` - [`String`](types-q-s.md#string) | | +| `latitude` - [`Float`](types-f-i.md#float) | | +| `longitude` - [`Float`](types-f-i.md#float) | | +| `name` - [`String`](types-q-s.md#string) | | +| `phone` - [`String`](types-q-s.md#string) | | +| `pickup_location_code` - [`String`](types-q-s.md#string) | | +| `postcode` - [`String`](types-q-s.md#string) | | +| `region` - [`String`](types-q-s.md#string) | | +| `region_id` - [`Int`](types-f-i.md#int) | | +| `street` - [`String`](types-q-s.md#string) | | #### Example @@ -1890,18 +1890,18 @@ Defines Pickup Location information. "city": "xyz789", "contact_name": "xyz789", "country_id": "abc123", - "description": "xyz789", + "description": "abc123", "email": "abc123", - "fax": "abc123", + "fax": "xyz789", "latitude": 987.65, - "longitude": 987.65, + "longitude": 123.45, "name": "xyz789", "phone": "abc123", - "pickup_location_code": "xyz789", + "pickup_location_code": "abc123", "postcode": "abc123", "region": "abc123", "region_id": 123, - "street": "xyz789" + "street": "abc123" } ``` @@ -1915,14 +1915,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | 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. | +| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -1949,22 +1949,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | 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. | +| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2000,8 +2000,8 @@ Top level object returned in a pickup locations search. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | #### Example @@ -2023,12 +2023,12 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -2059,7 +2059,7 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example @@ -2077,7 +2077,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | #### Example @@ -2095,12 +2095,12 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -2131,12 +2131,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -2313,8 +2313,8 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | +| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | #### Example @@ -2335,36 +2335,36 @@ Defines the filters to be used in the search. A filter contains at least one att | 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 | +| `activity` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Activity | +| `category_gear` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Category Gear | +| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `climate` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Climate | +| `collar` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Collar | +| `color` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Color | +| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `eco_collection` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Eco Collection | +| `erin_recommends` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Erin Recommends | +| `features_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Features | +| `format` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Format | +| `gender` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Gender | +| `material` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Material | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `new` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: New | +| `pattern` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Pattern | +| `performance_fabric` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Performance Fabric | +| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `purpose` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Purpose | +| `sale` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sale | +| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `size` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Size | +| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `sleeve` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sleeve | +| `strap_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Strap/Handle | +| `style_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bags | +| `style_bottom` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bottom | +| `style_general` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style General | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -2413,10 +2413,10 @@ Specifies the attribute to use for sorting search results and indicates whether | 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). | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -2434,8 +2434,8 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | #### Example @@ -2453,45 +2453,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | 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. | +| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](types-f-i.md#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. | +| `price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -2549,18 +2549,18 @@ Contains product image information, including the image URL and label. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { "disabled": true, - "label": "xyz789", - "position": 123, + "label": "abc123", + "position": 987, "url": "xyz789" } ``` @@ -2575,12 +2575,12 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | +| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | #### Example ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` @@ -2593,118 +2593,118 @@ Contains fields that are common to all types of products. | 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.)* | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#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.)* | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#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.)* | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#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.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#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_tiers` - [`[TierPrice]`](types-t-z.md#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. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](types-f-i.md#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. | +| `review_count` - [`Int!`](types-f-i.md#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.)* | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#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. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#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. | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#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_price` - [`Float`](types-f-i.md#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.)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#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.)* | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | #### Example ```json { "activity": "abc123", - "attribute_set_id": 987, - "canonical_url": "xyz789", + "attribute_set_id": 123, + "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "xyz789", - "climate": "abc123", - "collar": "abc123", + "climate": "xyz789", + "collar": "xyz789", "color": 987, "country_of_manufacture": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 987, + "eco_collection": 987, + "erin_recommends": 123, "features_bags": "abc123", - "format": 987, - "gender": "xyz789", - "gift_message_available": "xyz789", + "format": 123, + "gender": "abc123", + "gift_message_available": "abc123", "id": 987, "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 987, + "is_returnable": "abc123", + "manufacturer": 123, "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], @@ -2714,7 +2714,7 @@ Contains fields that are common to all types of products. "name": "xyz789", "new": 987, "new_from_date": "xyz789", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options_container": "xyz789", "pattern": "abc123", @@ -2728,31 +2728,31 @@ Contains fields that are common to all types of products. "related_products": [ProductInterface], "review_count": 123, "reviews": ProductReviews, - "sale": 987, + "sale": 123, "short_description": ComplexTextValue, - "size": 987, - "sku": "xyz789", + "size": 123, + "sku": "abc123", "sleeve": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 123.45, - "special_to_date": "xyz789", - "staged": true, + "special_to_date": "abc123", + "staged": false, "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "xyz789", + "strap_bags": "xyz789", + "style_bags": "abc123", "style_bottom": "xyz789", "style_general": "xyz789", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type_id": "xyz789", "uid": 4, - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website] @@ -2769,21 +2769,21 @@ An implementation of `ProductLinksInterface`. | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { - "link_type": "abc123", + "link_type": "xyz789", "linked_product_sku": "abc123", - "linked_product_type": "abc123", + "linked_product_type": "xyz789", "position": 123, - "sku": "xyz789" + "sku": "abc123" } ``` @@ -2797,11 +2797,11 @@ Contains information about linked products, including the link type and product | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -2813,10 +2813,10 @@ Contains information about linked products, including the link type and product ```json { - "link_type": "abc123", - "linked_product_sku": "xyz789", + "link_type": "xyz789", + "linked_product_sku": "abc123", "linked_product_type": "abc123", - "position": 123, + "position": 987, "sku": "abc123" } ``` @@ -2831,16 +2831,16 @@ Contains an image in base64 format and basic information about the image. | 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. | +| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { "base64_encoded_data": "xyz789", - "name": "abc123", + "name": "xyz789", "type": "xyz789" } ``` @@ -2855,23 +2855,23 @@ Contains a link to a video file and basic information about the video. | 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. | +| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | #### Example ```json { "media_type": "abc123", - "video_description": "xyz789", + "video_description": "abc123", "video_metadata": "abc123", - "video_provider": "abc123", + "video_provider": "xyz789", "video_title": "xyz789", - "video_url": "xyz789" + "video_url": "abc123" } ``` @@ -2887,7 +2887,7 @@ Represents a product price. |------------|-------------| | `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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#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 @@ -2935,13 +2935,13 @@ Contains details of a product review. | 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. | +| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](types-q-s.md#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. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example @@ -2949,7 +2949,7 @@ Contains details of a product review. { "average_rating": 987.65, "created_at": "xyz789", - "nickname": "abc123", + "nickname": "xyz789", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], "summary": "abc123", @@ -2967,15 +2967,15 @@ Contains data about a single aspect of a product review. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example ```json { "name": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -2989,15 +2989,15 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { "id": "abc123", - "value_id": "abc123" + "value_id": "xyz789" } ``` @@ -3011,15 +3011,15 @@ Contains details about a single aspect of a product review. | 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. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](types-q-s.md#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", + "id": "xyz789", "name": "abc123", "values": [ProductReviewRatingValueMetadata] } @@ -3035,14 +3035,14 @@ Contains details about a single value in a product review. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { - "value": "abc123", + "value": "xyz789", "value_id": "abc123" } ``` @@ -3076,7 +3076,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -3116,21 +3116,21 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | 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.)* | +| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json { - "customer_group_id": "abc123", - "percentage_value": 987.65, + "customer_group_id": "xyz789", + "percentage_value": 123.45, "qty": 987.65, "value": 987.65, - "website_id": 987.65 + "website_id": 123.45 } ``` @@ -3144,19 +3144,19 @@ Contains information about a product video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#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, + "disabled": true, + "label": "abc123", + "position": 123, "url": "abc123", "video_content": ProductMediaGalleryEntriesVideoContent } @@ -3172,13 +3172,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](types-a-b.md#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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -3190,7 +3190,7 @@ Contains the results of a `products` query. "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } ``` @@ -3207,15 +3207,15 @@ Contains details about a purchase order. | `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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](types-c-e.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -3266,13 +3266,13 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -3285,21 +3285,21 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | +| `message` - [`String`](types-q-s.md#string) | A formatted message. | +| `name` - [`String`](types-q-s.md#string) | The approver name. | +| `role` - [`String`](types-q-s.md#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. | +| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "name": "abc123", "role": "abc123", "status": "PENDING", - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -3331,16 +3331,16 @@ Contains details about a purchase order approval rule. | 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. | +| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -3349,12 +3349,12 @@ Contains details about a purchase order approval rule. "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "abc123", + "created_at": "abc123", + "created_by": "xyz789", "description": "abc123", - "name": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": "4", + "uid": 4, "updated_at": "xyz789" } ``` @@ -3440,12 +3440,12 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} ``` @@ -3458,22 +3458,22 @@ Defines a new purchase order approval rule. | 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. | +| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "applies_to": [4], + "applies_to": ["4"], "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", - "name": "abc123", + "name": "xyz789", "status": "ENABLED" } ``` @@ -3488,9 +3488,9 @@ Contains metadata that can be used to render rule edit forms. | 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. | +| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -3548,8 +3548,8 @@ Contains the approval rules that the customer can see. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -3571,19 +3571,19 @@ Contains details about a comment. | 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. | +| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | #### Example ```json { "author": Customer, - "created_at": "abc123", - "text": "xyz789", - "uid": 4 + "created_at": "xyz789", + "text": "abc123", + "uid": "4" } ``` @@ -3617,18 +3617,18 @@ Contains details about a status change. | 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. | +| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { "activity": "xyz789", - "created_at": "xyz789", - "message": "abc123", + "created_at": "abc123", + "message": "xyz789", "uid": 4 } ``` @@ -3644,14 +3644,14 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | +| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | #### Example ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "xyz789" + "rule_name": "abc123" } ``` @@ -3690,8 +3690,8 @@ Contains a list of purchase orders. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -3713,12 +3713,12 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of of purchase order UIDs. | #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -3753,9 +3753,9 @@ Defines the criteria to use to filter the list of purchase orders. | 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. | +| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](types-a-b.md#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 @@ -3764,7 +3764,7 @@ Defines the criteria to use to filter the list of purchase orders. { "company_purchase_orders": false, "created_date": FilterRangeTypeInput, - "require_my_approval": false, + "require_my_approval": true, "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 index 015559e11..da6c7fd25 100644 --- 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 @@ -7,7 +7,7 @@ | 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. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example @@ -16,7 +16,7 @@ { "code": "abc123", "id": 987, - "name": "xyz789" + "name": "abc123" } ``` @@ -48,7 +48,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -88,7 +88,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -106,7 +106,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -124,7 +124,7 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example @@ -142,7 +142,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -161,16 +161,16 @@ Specifies which items to remove from the cart. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_item_id": 987, - "cart_item_uid": "4" + "cart_item_uid": 4 } ``` @@ -184,7 +184,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -202,13 +202,16 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_item_uids": [4], "quote_uid": 4} +{ + "quote_item_uids": ["4"], + "quote_uid": "4" +} ``` @@ -221,7 +224,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -239,8 +242,8 @@ Defines which products to remove from a compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example @@ -258,8 +261,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -280,7 +283,7 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example @@ -316,7 +319,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -339,7 +342,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -352,7 +355,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -370,8 +373,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -392,8 +395,8 @@ Defines properties of a negotiable quote request. | 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. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -416,7 +419,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -437,13 +440,13 @@ Contains information needed to start a return request. | `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. | +| `order_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { - "comment_text": "xyz789", + "comment_text": "abc123", "contact_email": "abc123", "items": [RequestReturnItemInput], "order_uid": "4" @@ -460,9 +463,9 @@ Contains details about an item to be returned. | 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. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](types-f-i.md#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 @@ -473,7 +476,7 @@ Contains details about an item to be returned. EnteredCustomAttributeInput ], "order_item_uid": 4, - "quantity_to_return": 987.65, + "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -514,21 +517,21 @@ Defines the contents of a requisition list. |------------|-------------| | `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. | +| `items_count` - [`Int!`](types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "items": RequistionListItems, - "items_count": 987, - "name": "xyz789", - "uid": "4", - "updated_at": "xyz789" + "items_count": 123, + "name": "abc123", + "uid": 4, + "updated_at": "abc123" } ``` @@ -542,8 +545,8 @@ Defines requisition list filters. | 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. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -565,20 +568,20 @@ The interface for requisition list items. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#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) | +| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -586,8 +589,8 @@ The interface for requisition list items. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" } ``` @@ -601,9 +604,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#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. | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -613,9 +616,9 @@ Defines the items to add. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 123.45, + "quantity": 987.65, "selected_options": ["abc123"], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -631,7 +634,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -639,7 +642,7 @@ Defines customer requisition lists. { "items": [RequisitionList], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -655,7 +658,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `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. | +| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | #### Example @@ -663,7 +666,7 @@ Contains an array of items added to a requisition list. { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 123 + "total_pages": 987 } ``` @@ -683,10 +686,10 @@ Contains details about a return. | `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. | +| `order` - [`CustomerOrder`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -694,14 +697,14 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "abc123", + "created_at": "xyz789", "customer": ReturnCustomer, "items": [ReturnItem], "number": "abc123", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": 4 + "uid": "4" } ``` @@ -718,7 +721,7 @@ Contains details about a return comment. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example @@ -726,7 +729,7 @@ Contains details about a return comment. { "author_name": "xyz789", "created_at": "xyz789", - "text": "abc123", + "text": "xyz789", "uid": 4 } ``` @@ -742,7 +745,7 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example @@ -750,8 +753,8 @@ Contains details about a `ReturnCustomerAttribute` object. ```json { "label": "abc123", - "uid": 4, - "value": "abc123" + "uid": "4", + "value": "xyz789" } ``` @@ -773,8 +776,8 @@ The customer information for the return. ```json { - "email": "xyz789", - "firstname": "xyz789", + "email": "abc123", + "firstname": "abc123", "lastname": "abc123" } ``` @@ -790,11 +793,11 @@ Contains details about a product being returned. | 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. | +| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -802,8 +805,8 @@ Contains details about a product being returned. { "custom_attributes": [ReturnCustomAttribute], "order_item": OrderItemInterface, - "quantity": 987.65, - "request_quantity": 123.45, + "quantity": 123.45, + "request_quantity": 987.65, "status": "PENDING", "uid": 4 } @@ -864,7 +867,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `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. | +| `country` - [`Country!`](types-c-e.md#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. | @@ -875,7 +878,7 @@ Contains details about the shipping address used for receiving returned items. ```json { "city": "abc123", - "contact_name": "abc123", + "contact_name": "xyz789", "country": Country, "postcode": "abc123", "region": Region, @@ -895,15 +898,12 @@ Contains details about the carrier on a return. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example ```json -{ - "label": "abc123", - "uid": "4" -} +{"label": "xyz789", "uid": 4} ``` @@ -919,7 +919,7 @@ Contains shipping and tracking details. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1007,7 +1007,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | #### Example @@ -1029,7 +1029,7 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example @@ -1071,13 +1071,13 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | #### Example ```json -{"money": Money, "points": 123.45} +{"money": Money, "points": 987.65} ``` @@ -1093,7 +1093,7 @@ Contain details about the reward points transaction. | `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. | +| `points_change` - [`Float!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example @@ -1101,8 +1101,8 @@ Contain details about the reward points transaction. { "balance": RewardPointsAmount, "change_reason": "abc123", - "date": "xyz789", - "points_change": 987.65 + "date": "abc123", + "points_change": 123.45 } ``` @@ -1138,8 +1138,8 @@ Contains details about customer's reward points rate. | 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. | +| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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 @@ -1196,29 +1196,29 @@ Routable entities serve as the model for a rendered page. | 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. | +| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | +| [`CmsPage`](types-c-e.md#cmspage) | +| [`CategoryTree`](types-c-e.md#categorytree) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | #### Example ```json { - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -1241,7 +1241,7 @@ Contains details about a comment. ```json { - "message": "xyz789", + "message": "abc123", "timestamp": "abc123" } ``` @@ -1276,14 +1276,14 @@ Provides navigation for the query response. | 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. | +| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 987, "page_size": 123, "total_pages": 987} +{"current_page": 987, "page_size": 123, "total_pages": 123} ``` @@ -1314,10 +1314,10 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](types-f-i.md#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 | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example @@ -1325,9 +1325,9 @@ Contains details about a selected bundle option. ```json { "id": 987, - "label": "xyz789", + "label": "abc123", "type": "abc123", - "uid": "4", + "uid": 4, "values": [SelectedBundleOptionValue] } ``` @@ -1342,21 +1342,21 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | +| `id` - [`Int!`](types-f-i.md#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 | +| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { - "id": 987, - "label": "abc123", - "price": 123.45, + "id": 123, + "label": "xyz789", + "price": 987.65, "quantity": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -1370,22 +1370,22 @@ Contains details about a selected configurable option. | 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.)* | +| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](types-f-i.md#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_id` - [`Int!`](types-f-i.md#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", + "configurable_product_option_uid": 4, + "configurable_product_option_value_uid": 4, "id": 123, - "option_label": "abc123", - "value_id": 987, + "option_label": "xyz789", + "value_id": 123, "value_label": "abc123" } ``` @@ -1401,12 +1401,15 @@ Contains details about an attribute the buyer selected. | 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. | +| `value` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | #### Example ```json -{"attribute_code": "abc123", "value": 4} +{ + "attribute_code": "abc123", + "value": "4" +} ``` @@ -1419,11 +1422,11 @@ Identifies a customized product that has been placed in a cart. | 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. | +| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](types-a-b.md#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. | +| `sort_order` - [`Int!`](types-f-i.md#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. | @@ -1431,11 +1434,11 @@ Identifies a customized product that has been placed in a cart. ```json { - "customizable_option_uid": 4, - "id": 987, - "is_required": true, - "label": "xyz789", - "sort_order": 123, + "customizable_option_uid": "4", + "id": 123, + "is_required": false, + "label": "abc123", + "sort_order": 987, "type": "abc123", "values": [SelectedCustomizableOptionValue] } @@ -1451,10 +1454,10 @@ Identifies the value of the selected customized option. | 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.)* | +| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](types-f-i.md#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. | +| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | | `value` - [`String!`](#string) | The text identifying the selected value. | #### Example @@ -1462,10 +1465,10 @@ Identifies the value of the selected customized option. ```json { "customizable_option_value_uid": "4", - "id": 123, - "label": "xyz789", + "id": 987, + "label": "abc123", "price": CartItemSelectedOptionValuePrice, - "value": "abc123" + "value": "xyz789" } ``` @@ -1503,14 +1506,14 @@ Contains details about the selected shipping method and carrier. | 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.)* | +| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](types-k-p.md#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. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1518,10 +1521,10 @@ Contains details about the selected shipping method and carrier. { "amount": Money, "base_amount": Money, - "carrier_code": "xyz789", - "carrier_title": "xyz789", + "carrier_code": "abc123", + "carrier_title": "abc123", "method_code": "xyz789", - "method_title": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1537,7 +1540,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](types-f-i.md#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. | @@ -1545,7 +1548,7 @@ Defines the referenced product and the email sender and recipients. ```json { - "product_id": 987, + "product_id": 123, "recipients": [SendEmailToFriendRecipientInput], "sender": SendEmailToFriendSenderInput } @@ -1590,7 +1593,7 @@ An output object that contains information about the recipient. ```json { - "email": "xyz789", + "email": "abc123", "name": "abc123" } ``` @@ -1636,8 +1639,8 @@ An output object that contains information about the sender. ```json { "email": "xyz789", - "message": "xyz789", - "name": "abc123" + "message": "abc123", + "name": "xyz789" } ``` @@ -1659,8 +1662,8 @@ Contains details about the sender. ```json { - "email": "xyz789", - "message": "xyz789", + "email": "abc123", + "message": "abc123", "name": "abc123" } ``` @@ -1675,13 +1678,13 @@ Contains details about the configuration of the Email to a Friend feature. | 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. | +| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": false, "enabled_for_guests": false} +{"enabled_for_customers": true, "enabled_for_guests": true} ``` @@ -1694,8 +1697,8 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1713,7 +1716,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -1731,7 +1734,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -1753,7 +1756,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -1772,20 +1775,20 @@ Defines the gift options applied to the cart. | 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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_message": GiftMessageInput, "gift_receipt_included": false, - "gift_wrapping_id": "4", - "printed_card_included": true + "gift_wrapping_id": 4, + "printed_card_included": false } ``` @@ -1799,7 +1802,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | #### Example @@ -1824,7 +1827,7 @@ Defines the guest email and cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "email": "abc123" } ``` @@ -1839,7 +1842,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -1857,8 +1860,8 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1879,7 +1882,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -1897,15 +1900,15 @@ Defines the payment method of the specified negotiable quote. | 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. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -1919,7 +1922,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -1937,15 +1940,15 @@ Defines the shipping address to assign to the negotiable quote. | 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. | +| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "customer_address_id": "4", + "customer_address_id": 4, "quote_uid": "4", "shipping_addresses": [ NegotiableQuoteShippingAddressInput @@ -1963,7 +1966,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -1981,14 +1984,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#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", + "quote_uid": 4, "shipping_methods": [ShippingMethodInput] } ``` @@ -2003,7 +2006,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2022,13 +2025,13 @@ Applies a payment method to the quote. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "payment_method": PaymentMethodInput } ``` @@ -2044,7 +2047,7 @@ Applies a payment method to the cart. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2065,7 +2068,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2105,7 +2108,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2145,7 +2148,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2185,7 +2188,7 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example @@ -2242,23 +2245,23 @@ Defines whether bundle items must be shipped together. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example ```json { - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 123.45 + "product_sku": "abc123", + "quantity_shipped": 987.65 } ``` @@ -2272,19 +2275,19 @@ Order shipment item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example @@ -2295,8 +2298,8 @@ Order shipment item details. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "product_sku": "abc123", + "quantity_shipped": 123.45 } ``` @@ -2334,8 +2337,8 @@ Defines a single shipping address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](types-f-i.md#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. | @@ -2360,19 +2363,19 @@ Contains shipping addresses and methods. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#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. | +| `country` - [`CartAddressCountry!`](types-c-e.md#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.)* | +| `items_weight` - [`Float`](types-f-i.md#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. | +| `region` - [`CartAddressRegion`](types-c-e.md#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. | @@ -2386,8 +2389,8 @@ Contains shipping addresses and methods. "available_shipping_methods": [AvailableShippingMethod], "cart_items": [CartItemQuantity], "cart_items_v2": [CartItemInterface], - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country": CartAddressCountry, "customer_notes": "abc123", "firstname": "xyz789", @@ -2397,10 +2400,10 @@ Contains shipping addresses and methods. "postcode": "xyz789", "region": CartAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "xyz789", "uid": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -2414,7 +2417,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | #### Example @@ -2432,11 +2435,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](types-k-p.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | #### Example @@ -2468,7 +2471,7 @@ Defines the shipping carrier and method. ```json { "carrier_code": "xyz789", - "method_code": "xyz789" + "method_code": "abc123" } ``` @@ -2482,16 +2485,16 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#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. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#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. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2505,7 +2508,7 @@ An implementation for simple product cart items. "id": "abc123", "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -2521,166 +2524,166 @@ Defines a simple product, which is tangible and is usually sold in single units | 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.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#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. | +| `categories` - [`[CategoryInterface]`](types-c-e.md#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.)* | +| `color` - [`Int`](types-f-i.md#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.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#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.)* | +| `format` - [`Int`](types-f-i.md#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. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#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.)* | +| `manufacturer` - [`Int`](types-f-i.md#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.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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` - [`Int`](types-f-i.md#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. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#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. | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#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.)* | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#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. | +| `small_image` - [`ProductImage`](types-k-p.md#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_price` - [`Float`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#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. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#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. | +| `uid` - [`ID!`](types-f-i.md#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. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#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_rewrites` - [`[UrlRewrite]`](types-t-z.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "abc123", - "attribute_set_id": 987, + "activity": "xyz789", + "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "xyz789", + "category_gear": "abc123", "climate": "abc123", "collar": "abc123", - "color": 123, + "color": 987, "country_of_manufacture": "abc123", "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, "eco_collection": 987, - "erin_recommends": 123, + "erin_recommends": 987, "features_bags": "abc123", - "format": 123, + "format": 987, "gender": "xyz789", - "gift_message_available": "abc123", - "id": 123, + "gift_message_available": "xyz789", + "id": 987, "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 123, - "material": "xyz789", + "is_returnable": "xyz789", + "manufacturer": 987, + "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "abc123", "name": "abc123", - "new": 123, + "new": 987, "new_from_date": "xyz789", "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", - "pattern": "abc123", + "pattern": "xyz789", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 123, + "purpose": 987, "rating_summary": 987.65, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", + "relative_url": "abc123", "review_count": 123, "reviews": ProductReviews, - "sale": 987, + "sale": 123, "short_description": ComplexTextValue, - "size": 987, + "size": 123, "sku": "abc123", "sleeve": "abc123", "small_image": ProductImage, "special_from_date": "abc123", - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", "staged": false, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "abc123", "style_general": "xyz789", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", "uid": 4, - "updated_at": "abc123", + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "abc123", + "url_key": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -2694,8 +2697,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -2717,9 +2720,9 @@ Contains details about simple products added to a requisition list. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -2728,7 +2731,7 @@ Contains details about simple products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -2745,20 +2748,20 @@ Contains a simple 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. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": 4, + "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -2799,7 +2802,7 @@ Defines a possible sort field. ```json { "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -2820,7 +2823,7 @@ Contains a default value for sort fields and all available sort fields. ```json { - "default": "abc123", + "default": "xyz789", "options": [SortField] } ``` @@ -2843,7 +2846,7 @@ Contains information about a store's configuration. | `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. | +| `autocomplete_on_storefront` - [`Boolean`](types-a-b.md#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. | @@ -2853,17 +2856,17 @@ Contains information about a store's configuration. | `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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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. | @@ -2875,26 +2878,26 @@ Contains information about a store's configuration. | `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). | +| `demonotice` - [`Int`](types-f-i.md#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` - [`Int`](types-f-i.md#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. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#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` - [`Int`](types-f-i.md#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. | +| `logo_height` - [`Int`](types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](types-f-i.md#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. | @@ -2914,14 +2917,14 @@ Contains information about a store's configuration. | `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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `root_category_id` - [`Int`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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`. | @@ -2929,28 +2932,28 @@ Contains information about a store's configuration. | `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. | +| `show_cms_breadcrumbs` - [`Int`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#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. | +| `store_sort_order` - [`Int`](types-f-i.md#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.)* | +| `use_store_in_url` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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 @@ -2959,120 +2962,120 @@ Contains information about a store's configuration. { "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_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order_items": "xyz789", + "allow_guests_to_write_product_reviews": "abc123", + "allow_items": "xyz789", "allow_order": "xyz789", - "allow_printed_card": "xyz789", - "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", - "base_link_url": "abc123", + "allow_printed_card": "abc123", + "autocomplete_on_storefront": false, + "base_currency_code": "abc123", + "base_link_url": "xyz789", "base_media_url": "xyz789", - "base_static_url": "xyz789", - "base_url": "xyz789", + "base_static_url": "abc123", + "base_url": "abc123", "braintree_cc_vault_active": "xyz789", - "cart_gift_wrapping": "abc123", - "cart_printed_card": "xyz789", - "catalog_default_sort_by": "abc123", + "cart_gift_wrapping": "xyz789", + "cart_printed_card": "abc123", + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": true, - "check_money_order_enabled": false, + "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_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_sort_order": 123, "check_money_order_title": "abc123", "cms_home_page": "xyz789", - "cms_no_cookies": "abc123", + "cms_no_cookies": "xyz789", "cms_no_route": "abc123", "code": "abc123", "configurable_thumbnail_source": "xyz789", - "copyright": "xyz789", - "default_description": "xyz789", + "copyright": "abc123", + "default_description": "abc123", "default_display_currency_code": "xyz789", "default_keywords": "xyz789", - "default_title": "xyz789", - "demonotice": 987, - "enable_multiple_wishlists": "abc123", + "default_title": "abc123", + "demonotice": 123, + "enable_multiple_wishlists": "xyz789", "front": "xyz789", "grid_per_page": 987, - "grid_per_page_values": "abc123", + "grid_per_page_values": "xyz789", "head_includes": "xyz789", "head_shortcut_icon": "xyz789", - "header_logo_src": "xyz789", - "id": 987, + "header_logo_src": "abc123", + "id": 123, "is_default_store": false, - "is_default_store_group": false, + "is_default_store_group": true, "is_negotiable_quote_active": true, - "is_requisition_list_active": "abc123", + "is_requisition_list_active": "xyz789", "list_mode": "xyz789", "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": "abc123", + "logo_width": 987, + "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": "abc123", - "magento_reward_points_invitation_customer": "xyz789", - "magento_reward_points_invitation_customer_limit": "xyz789", + "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": "abc123", - "magento_reward_points_order": "abc123", - "magento_reward_points_register": "abc123", + "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": "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", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "abc123", + "maximum_number_of_wishlists": "abc123", + "minimum_password_length": "abc123", + "no_route": "xyz789", + "payment_payflowpro_cc_vault_active": "abc123", + "printed_card_price": "xyz789", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "xyz789", - "product_url_suffix": "abc123", + "product_url_suffix": "xyz789", "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": "abc123", - "sales_printed_card": "xyz789", - "secure_base_link_url": "abc123", + "sales_printed_card": "abc123", + "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "show_cms_breadcrumbs": 987, - "store_code": "4", + "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", + "store_sort_order": 987, + "timezone": "abc123", + "title_prefix": "abc123", + "title_separator": "abc123", + "title_suffix": "abc123", + "use_store_in_url": false, + "website_code": 4, "website_id": 987, "website_name": "abc123", - "weight_unit": "xyz789", - "welcome": "abc123", + "weight_unit": "abc123", + "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", + "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": 123, + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } ``` @@ -3087,11 +3090,11 @@ Indicates where an attribute can be displayed. | 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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example @@ -3099,7 +3102,7 @@ Indicates where an attribute can be displayed. { "position": 987, "use_in_layered_navigation": "NO", - "use_in_product_listing": false, + "use_in_product_listing": true, "use_in_search_results_layered_navigation": true, "visible_on_catalog_pages": false } @@ -3194,9 +3197,9 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | +| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | #### Example @@ -3212,7 +3215,7 @@ Describes the swatch type and a value. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](types-f-i.md#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.)* | @@ -3222,7 +3225,7 @@ Describes the swatch type and a value. ```json { "items_count": 123, - "label": "xyz789", + "label": "abc123", "swatch_data": SwatchData, "value_string": "abc123" } 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 index e201445db..aa065af60 100644 --- 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 @@ -8,16 +8,16 @@ Contains tax item details. | 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. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | #### Example ```json { "amount": Money, - "rate": 987.65, + "rate": 123.45, "title": "xyz789" } ``` @@ -30,7 +30,7 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -48,9 +48,9 @@ Defines a price based on the quantity purchased. | 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. | +| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -58,7 +58,7 @@ Defines a price based on the quantity purchased. { "discount": ProductDiscount, "final_price": Money, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -72,8 +72,8 @@ Modifies the specified items in the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example @@ -94,7 +94,7 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | #### Example @@ -112,7 +112,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -130,7 +130,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -148,7 +148,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -166,7 +166,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -184,7 +184,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | +| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | #### Example @@ -202,12 +202,12 @@ Defines updates to a `GiftRegistry` object. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -234,15 +234,15 @@ Defines updates to an item in a gift registry. | 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. | +| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { - "gift_registry_item_uid": "4", + "gift_registry_item_uid": 4, "note": "xyz789", "quantity": 123.45 } @@ -258,7 +258,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -276,7 +276,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -294,11 +294,11 @@ Defines updates to an existing registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -307,10 +307,10 @@ Defines updates to an existing registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "gift_registry_registrant_uid": 4, - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -324,7 +324,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -342,7 +342,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -360,15 +360,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -404,23 +404,23 @@ Defines the changes to be made to an approval rule. | 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. | +| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { - "applies_to": [4], + "applies_to": ["4"], "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", "uid": "4" } @@ -436,14 +436,14 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | +| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "name": "abc123" } ``` @@ -458,19 +458,19 @@ Defines which items in a requisition list to update. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | #### Example ```json { "entered_options": [EnteredOptionInput], - "item_id": "4", - "quantity": 987.65, - "selected_options": ["abc123"] + "item_id": 4, + "quantity": 123.45, + "selected_options": ["xyz789"] } ``` @@ -484,7 +484,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -502,7 +502,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -520,15 +520,15 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json { - "name": "abc123", + "name": "xyz789", "uid": 4, "visibility": "PUBLIC" } @@ -544,15 +544,15 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](types-q-s.md#string) | The request URL. | #### Example ```json { "parameters": [HttpQueryParameter], - "url": "abc123" + "url": "xyz789" } ``` @@ -606,7 +606,7 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example @@ -645,12 +645,12 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | #### Example ```json -{"purchase_order_uids": ["4"]} +{"purchase_order_uids": [4]} ``` @@ -664,7 +664,7 @@ Contains the results of validation attempts. | 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. | +| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -685,7 +685,7 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | #### Example @@ -703,13 +703,13 @@ An implementation for virtual product cart items. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -720,7 +720,7 @@ An implementation for virtual product cart items. "id": "abc123", "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -735,125 +735,125 @@ Defines a virtual product, which is a non-tangible product that does not require | 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 | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#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.)* | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#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)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#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 | +| `url_suffix` - [`String`](types-q-s.md#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", + "activity": "abc123", "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", - "collar": "abc123", + "category_gear": "xyz789", + "climate": "abc123", + "collar": "xyz789", "color": 123, "country_of_manufacture": "abc123", "created_at": "xyz789", "crosssell_products": [ProductInterface], "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 123, - "features_bags": "abc123", + "eco_collection": 987, + "erin_recommends": 987, + "features_bags": "xyz789", "format": 987, - "gender": "xyz789", + "gender": "abc123", "gift_message_available": "abc123", "id": 987, "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 123, + "is_returnable": "xyz789", + "manufacturer": 987, "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", "name": "abc123", - "new": 123, - "new_from_date": "xyz789", + "new": 987, + "new_from_date": "abc123", "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "abc123", - "performance_fabric": 123, + "options_container": "xyz789", + "pattern": "xyz789", + "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -863,34 +863,34 @@ Defines a virtual product, which is a non-tangible product that does not require "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "xyz789", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "sale": 123, "short_description": ComplexTextValue, "size": 123, "sku": "abc123", - "sleeve": "xyz789", + "sleeve": "abc123", "small_image": ProductImage, "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, + "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": "abc123", - "swatch_image": "xyz789", + "strap_bags": "xyz789", + "style_bags": "xyz789", + "style_bottom": "xyz789", + "style_general": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", + "type_id": "xyz789", "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "abc123", + "url_key": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website] @@ -907,8 +907,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -929,10 +929,10 @@ Contains details about virtual products added to a requisition list. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -940,8 +940,8 @@ Contains details about virtual products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 } ``` @@ -955,12 +955,12 @@ Contains a virtual product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -985,22 +985,22 @@ Deprecated. It should not be used on the storefront. Contains information about | 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.)* | +| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](types-q-s.md#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`](types-f-i.md#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, + "default_group_id": "xyz789", + "id": 987, "is_default": false, - "name": "xyz789", + "name": "abc123", "sort_order": 123 } ``` @@ -1016,14 +1016,14 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -1056,26 +1056,26 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](types-f-i.md#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_count` - [`Int`](types-f-i.md#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. | +| `name` - [`String`](types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](types-q-s.md#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, + "id": "4", "items": [WishlistItem], - "items_count": 987, + "items_count": 123, "items_v2": WishlistItems, - "name": "xyz789", - "sharing_code": "abc123", - "updated_at": "xyz789", + "name": "abc123", + "sharing_code": "xyz789", + "updated_at": "abc123", "visibility": "PUBLIC" } ``` @@ -1091,18 +1091,18 @@ Contains details about errors encountered when a customer added wish list items | 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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", + "message": "abc123", "wishlistId": "4", - "wishlistItemId": "4" + "wishlistItemId": 4 } ``` @@ -1137,21 +1137,21 @@ Contains details about a wish list item. | 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 | +| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { "added_at": "abc123", - "description": "xyz789", - "id": 987, + "description": "abc123", + "id": 123, "product": ProductInterface, - "qty": 987.65 + "qty": 123.45 } ``` @@ -1165,14 +1165,14 @@ Specifies the IDs of items to copy and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json { - "quantity": 987.65, + "quantity": 123.45, "wishlist_item_id": "4" } ``` @@ -1187,18 +1187,18 @@ Defines the items to add to a wish list. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](types-q-s.md#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", + "parent_sku": "abc123", "quantity": 123.45, "selected_options": ["4"], "sku": "abc123" @@ -1215,33 +1215,33 @@ The interface for wish list items. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | +| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | +| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | +| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, + "description": "xyz789", + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -1257,16 +1257,13 @@ Specifies the IDs of the items to move and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json -{ - "quantity": 123.45, - "wishlist_item_id": "4" -} +{"quantity": 987.65, "wishlist_item_id": 4} ``` @@ -1279,21 +1276,21 @@ Defines updates to items in a wish list. | 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. | +| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "entered_options": [EnteredOptionInput], - "quantity": 123.45, - "selected_options": [4], - "wishlist_item_id": 4 + "quantity": 987.65, + "selected_options": ["4"], + "wishlist_item_id": "4" } ``` @@ -1308,7 +1305,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1330,20 +1327,20 @@ Deprecated: Use the `Wishlist` type instead. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](types-q-s.md#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", + "items_count": 123, + "name": "xyz789", "sharing_code": "xyz789", - "updated_at": "xyz789" + "updated_at": "abc123" } ``` 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 58a10e875..914b59423 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 @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": true}}} +{"data": {"acceptCompanyInvitation": {"success": false}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -107,18 +107,18 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 987, + "max_order_commitment": 123, + "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, "total_quantity": 987.65 } @@ -132,13 +132,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -172,13 +172,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -216,13 +216,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -260,14 +260,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -293,7 +293,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -316,14 +316,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -352,7 +352,7 @@ mutation addProductsToCart( ```json { - "cartId": "xyz789", + "cartId": "abc123", "cartItems": [CartItemInput] } ``` @@ -376,13 +376,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -416,9 +416,9 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -430,14 +430,14 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -463,7 +463,7 @@ mutation addProductsToRequisitionList( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItems": [RequisitionListItemsInput] } ``` @@ -486,14 +486,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -546,13 +546,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -592,13 +592,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -642,14 +642,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -706,13 +706,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -746,13 +746,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -796,13 +796,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -836,13 +836,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -876,14 +876,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -937,13 +937,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -977,13 +977,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1017,13 +1017,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -1057,13 +1057,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -1097,13 +1097,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1137,13 +1137,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1187,13 +1187,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1223,7 +1223,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": true + "result": false } } } @@ -1235,13 +1235,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | | +| `cart_id` - [`String!`](types-q-s.md#string) | | #### Example @@ -1308,7 +1308,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -1327,7 +1327,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, @@ -1351,13 +1351,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1414,14 +1414,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_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ @@ -1429,7 +1429,7 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu ], "status": "xyz789", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1441,13 +1441,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | #### Example @@ -1476,7 +1476,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "abc123", + "error": "xyz789", "order": CustomerOrder } } @@ -1489,13 +1489,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1539,14 +1539,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | #### Example @@ -1662,7 +1662,7 @@ mutation changeCustomerPassword( ```json { "currentPassword": "abc123", - "newPassword": "xyz789" + "newPassword": "abc123" } ``` @@ -1679,21 +1679,21 @@ mutation changeCustomerPassword( "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "abc123", - "dob": "abc123", - "email": "abc123", + "default_shipping": "xyz789", + "dob": "xyz789", + "email": "xyz789", "firstname": "xyz789", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 123, - "id": 987, + "group_id": 987, + "id": 123, "is_subscribed": true, "job_title": "abc123", - "lastname": "abc123", - "middlename": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -1711,10 +1711,10 @@ mutation changeCustomerPassword( "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "abc123", - "taxvat": "xyz789", + "suffix": "xyz789", + "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1729,13 +1729,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCartOutput!`](#clearcartoutput) +**Response:** [`ClearCartOutput!`](types-c-e.md#clearcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ClearCartInput!`](#clearcartinput) | An input object that defines cart ID of the shopper. | +| `input` - [`ClearCartInput!`](types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | #### Example @@ -1779,13 +1779,13 @@ mutation clearCart($input: ClearCartInput!) { Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1805,7 +1805,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "abc123"} +{"cartUid": "xyz789"} ``` ##### Response @@ -1824,13 +1824,13 @@ mutation clearCustomerCart($cartUid: String!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1887,13 +1887,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -1927,13 +1927,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](#contactusoutput) +**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -1956,7 +1956,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": true}}} +{"data": {"contactUs": {"status": false}}} ``` @@ -1965,15 +1965,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2002,7 +2002,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": 4, + "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2025,15 +2025,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2067,7 +2067,7 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", + "sourceWishlistUid": 4, "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } @@ -2093,7 +2093,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Example @@ -2121,7 +2121,7 @@ mutation createBraintreeClientToken { Creates Client Token for Braintree PayPal Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Example @@ -2149,13 +2149,13 @@ mutation createBraintreePayPalClientToken { Creates Client Token for Braintree PayPal Vault Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `input` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | #### Example @@ -2189,13 +2189,13 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | #### Example @@ -2229,13 +2229,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | #### Example @@ -2269,13 +2269,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | #### Example @@ -2309,13 +2309,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | #### Example @@ -2349,13 +2349,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | #### Example @@ -2391,7 +2391,7 @@ mutation createCompareList($input: CreateCompareListInput) { "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -2403,13 +2403,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -2443,13 +2443,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | #### Example @@ -2506,26 +2506,26 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "data": { "createCustomerAddress": { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": true, + "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "xyz789", "id": 987, "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, "street": ["xyz789"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "xyz789", "vat_id": "xyz789" } @@ -2539,13 +2539,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2583,13 +2583,13 @@ Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](#string) +**Response:** [`String`](types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2610,7 +2610,7 @@ mutation createEmptyCart($input: createEmptyCartInput) { ##### Response ```json -{"data": {"createEmptyCart": "abc123"}} +{"data": {"createEmptyCart": "xyz789"}} ``` @@ -2619,13 +2619,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2663,13 +2663,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | #### Example @@ -2703,13 +2703,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -2739,10 +2739,10 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "abc123", + "response_message": "xyz789", "result": 987, - "result_code": 123, - "secure_token": "xyz789", + "result_code": 987, + "secure_token": "abc123", "secure_token_id": "abc123" } } @@ -2755,13 +2755,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -2792,9 +2792,9 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { "data": { "createPaymentOrder": { "amount": 987.65, - "currency_code": "abc123", + "currency_code": "xyz789", "id": "abc123", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "status": "xyz789" } } @@ -2807,13 +2807,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2855,13 +2855,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -2899,13 +2899,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -2949,10 +2949,10 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "xyz789", + "created_at": "xyz789", + "created_by": "abc123", "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", "uid": 4, "updated_at": "xyz789" @@ -2967,13 +2967,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | #### Example @@ -3013,13 +3013,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -3053,13 +3053,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3076,13 +3076,13 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyRole": {"success": false}}} +{"data": {"deleteCompanyRole": {"success": true}}} ``` @@ -3091,13 +3091,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3114,7 +3114,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3133,13 +3133,13 @@ Use deleteCompanyUserV2 instead. The current method only deactivates the user ac Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3162,7 +3162,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyUser": {"success": false}}} +{"data": {"deleteCompanyUser": {"success": true}}} ``` @@ -3171,13 +3171,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3200,7 +3200,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyUserV2": {"success": false}}} +{"data": {"deleteCompanyUserV2": {"success": true}}} ``` @@ -3209,13 +3209,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3247,7 +3247,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Example @@ -3262,7 +3262,7 @@ mutation deleteCustomer { ##### Response ```json -{"data": {"deleteCustomer": true}} +{"data": {"deleteCustomer": false}} ``` @@ -3271,13 +3271,13 @@ mutation deleteCustomer { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3292,13 +3292,13 @@ mutation deleteCustomerAddress($id: Int!) { ##### Variables ```json -{"id": 987} +{"id": 123} ``` ##### Response ```json -{"data": {"deleteCustomerAddress": true}} +{"data": {"deleteCustomerAddress": false}} ``` @@ -3307,13 +3307,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete a negotiable quote template -**Response:** [`Boolean!`](#boolean) +**Response:** [`Boolean!`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3334,7 +3334,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": false}} +{"data": {"deleteNegotiableQuoteTemplate": true}} ``` @@ -3343,13 +3343,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3402,13 +3402,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3428,7 +3428,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "xyz789"} +{"public_hash": "abc123"} ``` ##### Response @@ -3438,7 +3438,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } } } @@ -3450,13 +3450,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3496,13 +3496,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3544,14 +3544,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -3577,7 +3577,7 @@ mutation deleteRequisitionListItems( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItemUids": ["4"] } ``` @@ -3600,13 +3600,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -3635,7 +3635,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": false, + "status": true, "wishlists": [Wishlist] } } @@ -3648,13 +3648,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -3692,13 +3692,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -3743,11 +3743,11 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "estimateShippingMethods": [ { "amount": Money, - "available": true, + "available": false, "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "xyz789", - "error_message": "abc123", + "carrier_code": "xyz789", + "carrier_title": "abc123", + "error_message": "xyz789", "method_code": "abc123", "method_title": "xyz789", "price_excl_tax": Money, @@ -3764,13 +3764,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -3804,14 +3804,14 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](#customertoken) +**Response:** [`CustomerToken`](types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -3846,7 +3846,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "abc123" + "token": "xyz789" } } } @@ -3858,13 +3858,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -3902,13 +3902,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -3931,7 +3931,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom ##### Response ```json -{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}} +{ + "data": { + "generateNegotiableQuoteFromTemplate": { + "negotiable_quote_uid": "4" + } + } +} ``` @@ -3940,13 +3946,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -3980,14 +3986,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `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. | +| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4061,8 +4067,8 @@ mutation mergeCarts( ```json { - "source_cart_id": "xyz789", - "destination_cart_id": "abc123" + "source_cart_id": "abc123", + "destination_cart_id": "xyz789" } ``` @@ -4106,14 +4112,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4152,7 +4158,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } } @@ -4165,15 +4171,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4229,13 +4235,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4275,15 +4281,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4343,13 +4349,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4406,14 +4412,14 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "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": 123, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ @@ -4433,13 +4439,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4473,13 +4479,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4527,13 +4533,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -4571,13 +4577,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | #### Example @@ -4617,13 +4623,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -4667,13 +4673,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -4717,13 +4723,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4757,13 +4763,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4797,13 +4803,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -4837,13 +4843,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -4860,7 +4866,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -4875,14 +4881,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -4931,14 +4937,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -4963,7 +4969,10 @@ mutation removeGiftRegistryRegistrants( ##### Variables ```json -{"giftRegistryUid": 4, "registrantsUid": [4]} +{ + "giftRegistryUid": 4, + "registrantsUid": ["4"] +} ``` ##### Response @@ -4984,13 +4993,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5024,13 +5033,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5070,13 +5079,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5133,22 +5142,22 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "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, - "total_quantity": 123.45 + "status": "xyz789", + "template_id": "4", + "total_quantity": 987.65 } } } @@ -5160,13 +5169,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5202,7 +5211,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -5214,14 +5223,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5274,13 +5283,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5314,13 +5323,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -5339,7 +5348,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -5354,13 +5363,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5394,13 +5403,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5438,13 +5447,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](#string) | | +| `orderNumber` - [`String!`](types-q-s.md#string) | | #### Example @@ -5488,13 +5497,13 @@ mutation reorderItems($orderNumber: String!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -5532,13 +5541,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -5598,10 +5607,10 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, + "max_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -5609,8 +5618,8 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 123.45 + "template_id": "4", + "total_quantity": 987.65 } } } @@ -5622,13 +5631,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | #### Example @@ -5658,13 +5667,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -5708,15 +5717,15 @@ mutation requestReturn($input: RequestReturnInput!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | 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!`](types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | #### Example @@ -5741,15 +5750,15 @@ mutation resetPassword( ```json { "email": "xyz789", - "resetPasswordToken": "abc123", - "newPassword": "abc123" + "resetPasswordToken": "xyz789", + "newPassword": "xyz789" } ``` ##### Response ```json -{"data": {"resetPassword": true}} +{"data": {"resetPassword": false}} ``` @@ -5758,7 +5767,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) #### Example @@ -5784,13 +5793,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -5834,13 +5843,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -5880,13 +5889,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -5920,13 +5929,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -5960,13 +5969,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6000,13 +6009,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6040,13 +6049,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6086,13 +6095,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6132,13 +6141,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6178,13 +6187,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6224,13 +6233,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6287,22 +6296,22 @@ 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": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -6318,13 +6327,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -6372,13 +6381,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -6412,13 +6421,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -6478,9 +6487,9 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -6488,7 +6497,7 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, "total_quantity": 987.65 } @@ -6502,13 +6511,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -6542,13 +6551,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -6582,15 +6591,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -6634,13 +6643,13 @@ mutation shareGiftRegistry( Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -6710,7 +6719,7 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, "total_quantity": 987.65 } @@ -6724,13 +6733,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -6747,7 +6756,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -6762,13 +6771,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -6798,13 +6807,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -6838,13 +6847,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | #### Example @@ -6878,13 +6887,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | #### Example @@ -6918,13 +6927,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | #### Example @@ -6958,13 +6967,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | #### Example @@ -6998,13 +7007,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | #### Example @@ -7038,13 +7047,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7078,14 +7087,14 @@ mutation updateCustomer($input: CustomerInput!) { Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7148,28 +7157,28 @@ mutation updateCustomerAddress( "data": { "updateCustomerAddress": { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 987, + "customer_id": 123, "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "xyz789", + "fax": "abc123", + "firstname": "abc123", "id": 987, - "lastname": "abc123", - "middlename": "abc123", - "postcode": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "abc123" + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "xyz789" } } } @@ -7181,14 +7190,14 @@ mutation updateCustomerAddress( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -7214,7 +7223,7 @@ mutation updateCustomerEmail( ```json { - "email": "xyz789", + "email": "abc123", "password": "xyz789" } ``` @@ -7231,13 +7240,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7271,14 +7280,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -7304,7 +7313,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "giftRegistry": UpdateGiftRegistryInput } ``` @@ -7325,14 +7334,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -7381,14 +7390,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -7437,13 +7446,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -7483,13 +7492,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -7529,14 +7538,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -7589,13 +7598,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -7641,10 +7650,10 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "abc123", - "description": "abc123", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "abc123" } } @@ -7657,14 +7666,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -7690,7 +7699,7 @@ mutation updateRequisitionList( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "input": UpdateRequisitionListInput } ``` @@ -7713,14 +7722,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -7771,15 +7780,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to update. | -| `name` - [`String`](#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -7808,7 +7817,7 @@ mutation updateWishlist( ```json { "wishlistId": "4", - "name": "xyz789", + "name": "abc123", "visibility": "PUBLIC" } ``` @@ -7819,7 +7828,7 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "xyz789", + "name": "abc123", "uid": 4, "visibility": "PUBLIC" } @@ -7833,13 +7842,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | #### Example 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 bcc2c98ea..ac3776353 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](#attributesformoutput) +**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](#string) | Form code. | +| `formCode` - [`String!`](types-q-s.md#string) | Form code. | #### Example @@ -48,7 +48,7 @@ query attributesForm($formCode: String!) { ##### Variables ```json -{"formCode": "xyz789"} +{"formCode": "abc123"} ``` ##### Response @@ -70,14 +70,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -130,13 +130,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](#storeconfig) +**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -384,221 +384,221 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "absolute_footer": "abc123", + "absolute_footer": "xyz789", "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "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": "xyz789", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": true, - "base_currency_code": "abc123", - "base_link_url": "xyz789", - "base_media_url": "xyz789", - "base_static_url": "xyz789", + "autocomplete_on_storefront": false, + "base_currency_code": "xyz789", + "base_link_url": "abc123", + "base_media_url": "abc123", + "base_static_url": "abc123", "base_url": "abc123", "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": false, - "braintree_applepay_merchant_name": "xyz789", - "braintree_applepay_vault_active": false, + "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": true, + "braintree_cc_vault_cvv": false, "braintree_environment": "xyz789", "braintree_googlepay_btn_color": "xyz789", - "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_cctypes": "xyz789", "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": "xyz789", - "braintree_merchant_account_id": "xyz789", + "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_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_credit_show": false, "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": "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": "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": false, + "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": "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_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": "abc123", + "braintree_paypal_button_location_checkout_type_credit_show": true, + "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_logo_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": "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": "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_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_label": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_color": "abc123", "braintree_paypal_button_location_productpage_type_credit_label": "abc123", "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789", "braintree_paypal_button_location_productpage_type_credit_show": true, "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123", "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123", "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789", - "braintree_paypal_button_location_productpage_type_messaging_show": true, - "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789", + "braintree_paypal_button_location_productpage_type_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_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_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": true, - "braintree_paypal_credit_uk_merchant_name": "abc123", + "braintree_paypal_button_location_productpage_type_paypal_show": false, + "braintree_paypal_credit_uk_merchant_name": "xyz789", "braintree_paypal_display_on_shopping_cart": true, - "braintree_paypal_merchant_country": "xyz789", + "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_send_cart_line_items": true, "braintree_paypal_vault_active": false, "cart_expires_in_days": 123, "cart_gift_wrapping": "xyz789", - "cart_printed_card": "abc123", + "cart_printed_card": "xyz789", "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": "abc123", + "check_money_order_make_check_payable_to": "abc123", + "check_money_order_max_order_total": "xyz789", "check_money_order_min_order_total": "abc123", "check_money_order_new_order_status": "xyz789", "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", - "cms_home_page": "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": "xyz789", "cms_no_route": "abc123", "code": "abc123", - "configurable_thumbnail_source": "xyz789", + "configurable_thumbnail_source": "abc123", "contact_enabled": true, - "copyright": "xyz789", + "copyright": "abc123", "countries_with_required_region": "xyz789", "create_account_confirmation": false, "customer_access_token_lifetime": 987.65, "default_country": "xyz789", - "default_description": "abc123", + "default_description": "xyz789", "default_display_currency_code": "xyz789", "default_keywords": "xyz789", "default_title": "abc123", "demonotice": 123, - "display_state_if_optional": false, - "enable_multiple_wishlists": "xyz789", + "display_state_if_optional": true, + "enable_multiple_wishlists": "abc123", "front": "xyz789", - "grid_per_page": 123, - "grid_per_page_values": "abc123", + "grid_per_page": 987, + "grid_per_page_values": "xyz789", "head_includes": "xyz789", - "head_shortcut_icon": "xyz789", + "head_shortcut_icon": "abc123", "header_logo_src": "xyz789", "id": 123, - "is_default_store": false, + "is_default_store": true, "is_default_store_group": false, - "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": true, + "is_guest_checkout_enabled": false, + "is_negotiable_quote_active": false, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "xyz789", - "list_mode": "xyz789", + "is_requisition_list_active": "abc123", + "list_mode": "abc123", "list_per_page": 123, "list_per_page_values": "xyz789", - "locale": "xyz789", - "logo_alt": "xyz789", + "locale": "abc123", + "logo_alt": "abc123", "logo_height": 123, - "logo_width": 123, + "logo_width": 987, "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": "xyz789", - "magento_reward_points_invitation_customer_limit": "abc123", - "magento_reward_points_invitation_order": "abc123", + "magento_reward_general_publish_history": "abc123", + "magento_reward_points_invitation_customer": "abc123", + "magento_reward_points_invitation_customer_limit": "xyz789", + "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "abc123", - "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "abc123", + "magento_reward_points_order": "abc123", + "magento_reward_points_register": "xyz789", "magento_reward_points_review": "abc123", "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", "max_items_in_order_summary": 123, "maximum_number_of_wishlists": "xyz789", - "minicart_display": true, + "minicart_display": false, "minicart_max_items": 987, - "minimum_password_length": "abc123", - "newsletter_enabled": false, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, "no_route": "abc123", - "optional_zip_countries": "xyz789", + "optional_zip_countries": "abc123", "order_cancellation_enabled": false, "order_cancellation_reasons": [ CancellationReason ], "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "abc123", + "printed_card_price": "xyz789", "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", + "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": "abc123", - "sales_printed_card": "xyz789", - "secure_base_link_url": "abc123", + "sales_printed_card": "abc123", + "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", - "secure_base_static_url": "abc123", + "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": 987, - "shopping_cart_display_shipping": 987, + "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": false, - "show_cms_breadcrumbs": 123, - "store_code": "4", + "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_separator": "abc123", "title_suffix": "xyz789", "use_store_in_url": true, - "website_code": "4", + "website_code": 4, "website_id": 123, "website_name": "abc123", - "weight_unit": "xyz789", + "weight_unit": "abc123", "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": false, + "zero_subtotal_enabled": true, "zero_subtotal_new_order_status": "xyz789", "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", @@ -616,13 +616,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](#cart) +**Response:** [`Cart`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -708,16 +708,16 @@ query cart($cart_id: String!) { 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": false, + "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 123.45 @@ -732,15 +732,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](#categoryresult) +**Response:** [`CategoryResult`](types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -802,13 +802,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](#categorytree) +**Response:** [`CategoryTree`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -878,43 +878,43 @@ query category($id: Int) { { "data": { "category": { - "automatic_sorting": "xyz789", + "automatic_sorting": "abc123", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "abc123", - "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", - "description": "abc123", + "custom_layout_update_file": "abc123", + "default_sort_by": "xyz789", + "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 987.65, - "id": 123, + "id": 987, "image": "abc123", "include_in_menu": 987, - "is_anchor": 987, - "landing_page": 123, - "level": 987, + "is_anchor": 123, + "landing_page": 987, + "level": 123, "meta_description": "xyz789", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "xyz789", - "name": "xyz789", + "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": "xyz789", - "staged": false, + "staged": true, "type": "CMS_PAGE", "uid": 4, "updated_at": "xyz789", "url_key": "abc123", - "url_path": "xyz789", - "url_suffix": "xyz789" + "url_path": "abc123", + "url_suffix": "abc123" } } } @@ -930,15 +930,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](#categorytree) +**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -1022,41 +1022,41 @@ query categoryList( "categoryList": [ { "automatic_sorting": "xyz789", - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "xyz789", + "created_at": "abc123", "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", + "default_sort_by": "xyz789", "description": "abc123", - "display_mode": "abc123", + "display_mode": "xyz789", "filter_price_range": 123.45, "id": 987, - "image": "abc123", + "image": "xyz789", "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 123, + "is_anchor": 123, + "landing_page": 987, "level": 987, "meta_description": "xyz789", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "abc123", - "name": "xyz789", - "path": "abc123", - "path_in_store": "xyz789", + "name": "abc123", + "path": "xyz789", + "path_in_store": "abc123", "position": 123, - "product_count": 987, + "product_count": 123, "products": CategoryProducts, - "redirect_code": 123, - "relative_url": "xyz789", + "redirect_code": 987, + "relative_url": "abc123", "staged": false, "type": "CMS_PAGE", "uid": "4", "updated_at": "abc123", "url_key": "abc123", - "url_path": "abc123", + "url_path": "xyz789", "url_suffix": "abc123" } ] @@ -1070,7 +1070,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) #### Example @@ -1097,13 +1097,13 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 123, - "checkbox_text": "abc123", - "content": "xyz789", - "content_height": "xyz789", - "is_html": true, + "agreement_id": 987, + "checkbox_text": "xyz789", + "content": "abc123", + "content_height": "abc123", + "is_html": false, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ] } @@ -1116,13 +1116,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](#cmsblocks) +**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -1141,7 +1141,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["xyz789"]} +{"identifiers": ["abc123"]} ``` ##### Response @@ -1156,14 +1156,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](#cmspage) +**Response:** [`CmsPage`](types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The ID of the CMS page. | -| `identifier` - [`String`](#string) | The identifier of the CMS page. | +| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -1197,7 +1197,7 @@ query cmsPage( ##### Variables ```json -{"id": 987, "identifier": "xyz789"} +{"id": 123, "identifier": "abc123"} ``` ##### Response @@ -1207,15 +1207,15 @@ query cmsPage( "data": { "cmsPage": { "content": "abc123", - "content_heading": "xyz789", + "content_heading": "abc123", "identifier": "abc123", - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "xyz789", + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "abc123", "page_layout": "abc123", "redirect_code": 123, - "relative_url": "abc123", - "title": "xyz789", + "relative_url": "xyz789", + "title": "abc123", "type": "CMS_PAGE", "url_key": "abc123" } @@ -1229,7 +1229,7 @@ query cmsPage( Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](#company) +**Response:** [`Company`](types-c-e.md#company) #### Example @@ -1296,9 +1296,9 @@ query company { "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, - "legal_name": "abc123", + "legal_name": "xyz789", "name": "xyz789", "payment_methods": ["abc123"], "reseller_id": "xyz789", @@ -1321,13 +1321,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1361,9 +1361,9 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -1375,7 +1375,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](#country) +**Response:** [`[Country]`](types-c-e.md#country) #### Example @@ -1405,10 +1405,10 @@ query countries { { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "xyz789", - "id": "abc123", + "full_name_locale": "abc123", + "id": "xyz789", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } ] } @@ -1421,13 +1421,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](#country) +**Response:** [`Country`](types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](#string) | | +| `id` - [`String`](types-q-s.md#string) | | #### Example @@ -1463,9 +1463,9 @@ query country($id: String) { "available_regions": [Region], "full_name_english": "xyz789", "full_name_locale": "xyz789", - "id": "xyz789", + "id": "abc123", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } } } @@ -1477,7 +1477,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](#currency) +**Response:** [`Currency`](types-c-e.md#currency) #### Example @@ -1512,9 +1512,9 @@ query currency { "base_currency_code": "abc123", "base_currency_symbol": "xyz789", "default_display_currecy_code": "abc123", - "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "xyz789", + "default_display_currecy_symbol": "abc123", + "default_display_currency_code": "abc123", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } } @@ -1531,13 +1531,13 @@ Use `customAttributeMetadataV2` query instead. Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1575,13 +1575,13 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | #### Example @@ -1625,7 +1625,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Example @@ -1737,35 +1737,35 @@ query customer { "data": { "customer": { "addresses": [CustomerAddress], - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", - "default_billing": "xyz789", - "default_shipping": "abc123", - "dob": "abc123", + "date_of_birth": "xyz789", + "default_billing": "abc123", + "default_shipping": "xyz789", + "dob": "xyz789", "email": "abc123", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 123, - "id": 123, + "group_id": 987, + "id": 987, "is_subscribed": false, "job_title": "xyz789", - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1774,11 +1774,11 @@ query customer { "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "xyz789", - "taxvat": "xyz789", + "structure_id": 4, + "suffix": "abc123", + "taxvat": "abc123", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1793,7 +1793,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Example @@ -1873,19 +1873,19 @@ query customerCart { 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": false, + "id": 4, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1897,7 +1897,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) #### Example @@ -1933,7 +1933,7 @@ query customerDownloadableProducts { Use the `customer` query instead. -**Response:** [`CustomerOrders`](#customerorders) +**Response:** [`CustomerOrders`](types-c-e.md#customerorders) #### Example @@ -1961,7 +1961,7 @@ query customerOrders { "customerOrders": { "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -1973,7 +1973,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) #### Example @@ -2005,15 +2005,15 @@ query customerPaymentTokens { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](#dynamicblocks) +**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -2059,7 +2059,7 @@ query dynamicBlocks( "dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -2071,13 +2071,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](#hostedprourl) +**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -2115,13 +2115,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](#payflowlinktoken) +**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2153,7 +2153,7 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "mode": "TEST", "paypal_url": "abc123", "secure_token": "abc123", - "secure_token_id": "xyz789" + "secure_token_id": "abc123" } } } @@ -2165,13 +2165,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2223,14 +2223,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | #### Example @@ -2259,8 +2259,8 @@ query getPaymentOrder( ```json { - "cartId": "abc123", - "id": "abc123" + "cartId": "xyz789", + "id": "xyz789" } ``` @@ -2271,7 +2271,7 @@ query getPaymentOrder( "data": { "getPaymentOrder": { "id": "xyz789", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, "status": "abc123" } @@ -2285,13 +2285,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2329,13 +2329,13 @@ query getPaymentSDK($location: PaymentLocation!) { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -2367,7 +2367,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } } } @@ -2379,13 +2379,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](#giftregistry) +**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -2432,20 +2432,20 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "abc123", + "created_at": "xyz789", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], "event_name": "xyz789", "items": [GiftRegistryItemInterface], "message": "abc123", - "owner_name": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } } } @@ -2457,13 +2457,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | #### Example @@ -2485,7 +2485,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2496,10 +2496,10 @@ query giftRegistryEmailSearch($email: String!) { "giftRegistryEmailSearch": [ { "event_date": "xyz789", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": "4", "location": "xyz789", - "name": "xyz789", + "name": "abc123", "type": "xyz789" } ] @@ -2513,13 +2513,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -2541,7 +2541,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -2553,10 +2553,10 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { { "event_date": "xyz789", "event_title": "abc123", - "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", - "type": "xyz789" + "gift_registry_uid": 4, + "location": "xyz789", + "name": "abc123", + "type": "abc123" } ] } @@ -2569,15 +2569,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](#string) | The first name of the registrant. | -| `lastName` - [`String!`](#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](#id) | The type UID of the registry. | +| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2608,8 +2608,8 @@ query giftRegistryTypeSearch( ```json { - "firstName": "xyz789", - "lastName": "abc123", + "firstName": "abc123", + "lastName": "xyz789", "giftRegistryTypeUid": 4 } ``` @@ -2621,10 +2621,10 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": 4, - "location": "abc123", + "location": "xyz789", "name": "abc123", "type": "xyz789" } @@ -2639,7 +2639,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](#giftregistrytype) +**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) #### Example @@ -2667,8 +2667,8 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", - "uid": 4 + "label": "abc123", + "uid": "4" } ] } @@ -2681,13 +2681,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and postcode. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderInformationInput!`](#orderinformationinput) | | +| `input` - [`OrderInformationInput!`](types-k-p.md#orderinformationinput) | | #### Example @@ -2770,29 +2770,29 @@ query guestOrder($input: OrderInformationInput!) { "guestOrder": { "applied_coupons": [AppliedCoupon], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "grand_total": 987.65, + "grand_total": 123.45, "id": "4", - "increment_id": "abc123", + "increment_id": "xyz789", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", - "order_date": "xyz789", - "order_number": "abc123", + "order_date": "abc123", + "order_number": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", + "shipping_method": "abc123", "status": "abc123", "token": "abc123", "total": OrderTotal @@ -2807,13 +2807,13 @@ query guestOrder($input: OrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | #### Example @@ -2900,18 +2900,18 @@ query guestOrderByToken($input: OrderTokenInput!) { "comments": [SalesCommentItem], "created_at": "abc123", "credit_memos": [CreditMemo], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "grand_total": 123.45, - "id": 4, + "id": "4", "increment_id": "xyz789", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", - "order_date": "abc123", + "order_date": "xyz789", "order_number": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, @@ -2919,7 +2919,7 @@ query guestOrderByToken($input: OrderTokenInput!) { "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "xyz789", + "status": "abc123", "token": "xyz789", "total": OrderTotal } @@ -2933,13 +2933,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2971,13 +2971,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2994,13 +2994,13 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} ``` @@ -3009,13 +3009,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](#string) | | +| `name` - [`String!`](types-q-s.md#string) | | #### Example @@ -3038,7 +3038,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} ``` @@ -3047,13 +3047,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -3070,7 +3070,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3085,13 +3085,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to check. | +| `email` - [`String!`](types-q-s.md#string) | The email address to check. | #### Example @@ -3108,7 +3108,7 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3123,13 +3123,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](#negotiablequote) +**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | | +| `uid` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3196,7 +3196,7 @@ query negotiableQuote($uid: ID!) { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "email": "xyz789", + "email": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], @@ -3207,9 +3207,9 @@ query negotiableQuote($uid: ID!) { NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -3221,13 +3221,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](#id) | | +| `templateId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3273,7 +3273,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": "4"} +{"templateId": 4} ``` ##### Response @@ -3284,20 +3284,20 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", "total_quantity": 987.65 } @@ -3311,16 +3311,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -3385,16 +3385,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3459,18 +3459,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](#pickuplocations) +**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3525,7 +3525,7 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -3537,7 +3537,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) #### Example @@ -3571,17 +3571,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](#products) +**Response:** [`Products`](types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -3629,7 +3629,7 @@ query products( ```json { - "search": "xyz789", + "search": "abc123", "filter": ProductAttributeFilterInput, "pageSize": 20, "currentPage": 1, @@ -3661,7 +3661,7 @@ query products( Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3692,7 +3692,7 @@ query recaptchaV3Config { "forms": ["PLACE_ORDER"], "is_enabled": true, "language_code": "abc123", - "minimum_score": 987.65, + "minimum_score": 123.45, "website_key": "abc123" } } @@ -3705,13 +3705,13 @@ query recaptchaV3Config { Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](#routableinterface) +**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3730,7 +3730,7 @@ query route($url: String!) { ##### Variables ```json -{"url": "xyz789"} +{"url": "abc123"} ``` ##### Response @@ -3740,7 +3740,7 @@ query route($url: String!) { "data": { "route": { "redirect_code": 987, - "relative_url": "xyz789", + "relative_url": "abc123", "type": "CMS_PAGE" } } @@ -3753,7 +3753,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](#storeconfig) +**Response:** [`StoreConfig`](types-q-s.md#storeconfig) #### Example @@ -3994,24 +3994,24 @@ query storeConfig { { "data": { "storeConfig": { - "absolute_footer": "abc123", + "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": "abc123", + "allow_guests_to_write_product_reviews": "xyz789", "allow_items": "xyz789", - "allow_order": "abc123", - "allow_printed_card": "xyz789", + "allow_order": "xyz789", + "allow_printed_card": "abc123", "autocomplete_on_storefront": true, - "base_currency_code": "abc123", - "base_link_url": "xyz789", + "base_currency_code": "xyz789", + "base_link_url": "abc123", "base_media_url": "abc123", "base_static_url": "abc123", "base_url": "xyz789", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": false, - "braintree_3dsecure_specificcountry": "xyz789", - "braintree_3dsecure_threshold_amount": "xyz789", + "braintree_3dsecure_specificcountry": "abc123", + "braintree_3dsecure_threshold_amount": "abc123", "braintree_3dsecure_verify_3dsecure": false, "braintree_ach_direct_debit_vault_active": true, "braintree_applepay_merchant_name": "xyz789", @@ -4019,199 +4019,199 @@ query storeConfig { "braintree_cc_vault_active": "xyz789", "braintree_cc_vault_cvv": true, "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "xyz789", - "braintree_googlepay_cctypes": "xyz789", - "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": false, + "braintree_googlepay_btn_color": "abc123", + "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_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": "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_layout": "abc123", "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", - "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123", + "braintree_paypal_button_location_cart_type_messaging_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_paylater_label": "abc123", + "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": "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_paylater_show": false, + "braintree_paypal_button_location_cart_type_paypal_color": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_show": false, - "braintree_paypal_button_location_checkout_type_credit_color": "abc123", + "braintree_paypal_button_location_cart_type_paypal_show": true, + "braintree_paypal_button_location_checkout_type_credit_color": "xyz789", "braintree_paypal_button_location_checkout_type_credit_label": "abc123", - "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789", + "braintree_paypal_button_location_checkout_type_credit_shape": "abc123", "braintree_paypal_button_location_checkout_type_credit_show": false, - "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_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_logo_position": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_show": true, "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789", - "braintree_paypal_button_location_checkout_type_paylater_show": true, + "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": "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_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": "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_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_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_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": "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_button_location_productpage_type_paypal_shape": "abc123", + "braintree_paypal_button_location_productpage_type_paypal_show": false, + "braintree_paypal_credit_uk_merchant_name": "xyz789", + "braintree_paypal_display_on_shopping_cart": false, + "braintree_paypal_merchant_country": "xyz789", "braintree_paypal_merchant_name_override": "xyz789", "braintree_paypal_require_billing_address": true, - "braintree_paypal_send_cart_line_items": false, + "braintree_paypal_send_cart_line_items": true, "braintree_paypal_vault_active": false, - "cart_expires_in_days": 123, - "cart_gift_wrapping": "abc123", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "xyz789", + "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": "abc123", + "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": "abc123", - "check_money_order_new_order_status": "abc123", + "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": "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": "abc123", + "check_money_order_title": "xyz789", "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", "cms_no_route": "xyz789", - "code": "abc123", - "configurable_thumbnail_source": "xyz789", + "code": "xyz789", + "configurable_thumbnail_source": "abc123", "contact_enabled": true, - "copyright": "xyz789", - "countries_with_required_region": "xyz789", + "copyright": "abc123", + "countries_with_required_region": "abc123", "create_account_confirmation": true, "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, + "default_country": "abc123", + "default_description": "abc123", + "default_display_currency_code": "xyz789", + "default_keywords": "abc123", + "default_title": "xyz789", + "demonotice": 987, "display_state_if_optional": true, - "enable_multiple_wishlists": "xyz789", - "front": "xyz789", + "enable_multiple_wishlists": "abc123", + "front": "abc123", "grid_per_page": 987, "grid_per_page_values": "xyz789", - "head_includes": "abc123", - "head_shortcut_icon": "xyz789", + "head_includes": "xyz789", + "head_shortcut_icon": "abc123", "header_logo_src": "xyz789", - "id": 987, + "id": 123, "is_default_store": true, - "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": "abc123", - "list_mode": "abc123", - "list_per_page": 123, - "list_per_page_values": "xyz789", + "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": 987, + "list_per_page_values": "abc123", "locale": "xyz789", - "logo_alt": "abc123", - "logo_height": 123, + "logo_alt": "xyz789", + "logo_height": 987, "logo_width": 987, "magento_reward_general_is_enabled": "xyz789", - "magento_reward_general_is_enabled_on_front": "abc123", - "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_is_enabled_on_front": "xyz789", + "magento_reward_general_min_points_balance": "abc123", "magento_reward_general_publish_history": "abc123", "magento_reward_points_invitation_customer": "xyz789", "magento_reward_points_invitation_customer_limit": "abc123", - "magento_reward_points_invitation_order": "abc123", - "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "abc123", + "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_register": "abc123", + "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "xyz789", "minicart_display": true, - "minicart_max_items": 987, + "minicart_max_items": 123, "minimum_password_length": "xyz789", - "newsletter_enabled": true, + "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], - "payment_payflowpro_cc_vault_active": "abc123", + "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": "xyz789", - "quickorder_active": true, + "product_reviews_enabled": "xyz789", + "product_url_suffix": "abc123", + "quickorder_active": false, "required_character_classes_number": "xyz789", "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": "abc123", - "sales_printed_card": "abc123", - "secure_base_link_url": "xyz789", + "sales_printed_card": "xyz789", + "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_static_url": "abc123", + "secure_base_url": "abc123", "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": 987, + "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_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, - "show_cms_breadcrumbs": 123, + "show_cms_breadcrumbs": 987, "store_code": "4", - "store_group_code": 4, + "store_group_code": "4", "store_group_name": "abc123", - "store_name": "abc123", - "store_sort_order": 123, - "timezone": "abc123", + "store_name": "xyz789", + "store_sort_order": 987, + "timezone": "xyz789", "title_prefix": "abc123", "title_separator": "xyz789", "title_suffix": "abc123", "use_store_in_url": false, - "website_code": 4, - "website_id": 123, - "website_name": "xyz789", - "weight_unit": "abc123", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, + "website_code": "4", + "website_id": 987, + "website_name": "abc123", + "weight_unit": "xyz789", + "welcome": "xyz789", + "zero_subtotal_enable_for_specific_countries": true, "zero_subtotal_enabled": true, "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "abc123", - "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "abc123" + "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 987, + "zero_subtotal_title": "xyz789" } } } @@ -4227,13 +4227,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](#entityurl) +**Response:** [`EntityUrl`](types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4255,7 +4255,7 @@ query urlResolver($url: String!) { ##### Variables ```json -{"url": "abc123"} +{"url": "xyz789"} ``` ##### Response @@ -4266,9 +4266,9 @@ query urlResolver($url: String!) { "urlResolver": { "canonical_url": "abc123", "entity_uid": "4", - "id": 987, - "redirectCode": 123, - "relative_url": "xyz789", + "id": 123, + "redirectCode": 987, + "relative_url": "abc123", "type": "CMS_PAGE" } } @@ -4285,7 +4285,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](#wishlistoutput) +**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) #### Example @@ -4312,10 +4312,10 @@ query wishlist { "data": { "wishlist": { "items": [WishlistItem], - "items_count": 987, + "items_count": 123, "name": "xyz789", - "sharing_code": "abc123", - "updated_at": "abc123" + "sharing_code": "xyz789", + "updated_at": "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 index 843aaba79..1c419bb7c 100644 --- 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 @@ -8,12 +8,12 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -26,7 +26,7 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example @@ -48,7 +48,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -66,8 +66,8 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example @@ -88,7 +88,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -104,14 +104,14 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [DownloadableProductCartItemInput] } ``` @@ -126,7 +126,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -144,10 +144,10 @@ Defines a new registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | #### Example @@ -156,9 +156,9 @@ Defines a new registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -172,7 +172,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -190,8 +190,8 @@ Contains details about the cart after adding products to it. | 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. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -212,8 +212,8 @@ Contains products to add to an existing compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example @@ -231,7 +231,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -249,8 +249,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -271,15 +271,15 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { "comment": "abc123", - "purchase_order_uid": "4" + "purchase_order_uid": 4 } ``` @@ -293,7 +293,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -311,8 +311,8 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example @@ -321,7 +321,7 @@ Defines the purchase order and cart to act on. { "cart_id": "abc123", "purchase_order_uid": 4, - "replace_existing_cart_items": true + "replace_existing_cart_items": false } ``` @@ -335,14 +335,14 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | +| `message` - [`String!`](types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "type": "OUT_OF_STOCK" } ``` @@ -377,7 +377,7 @@ Output of the request to add items in a requisition list to the cart. | 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. | +| `cart` - [`Cart`](types-c-e.md#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 @@ -388,7 +388,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } ``` @@ -402,13 +402,16 @@ Defines a return comment. | 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. | +| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example ```json -{"comment_text": "abc123", "return_uid": 4} +{ + "comment_text": "xyz789", + "return_uid": "4" +} ``` @@ -421,7 +424,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `return` - [`Return`](types-q-s.md#return) | The modified return. | #### Example @@ -439,16 +442,16 @@ Defines tracking information to be added to the return. | 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. | +| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { "carrier_uid": 4, - "return_uid": "4", + "return_uid": 4, "tracking_number": "xyz789" } ``` @@ -463,8 +466,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -485,14 +488,14 @@ Defines the simple and group products to add to the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [SimpleProductCartItemInput] } ``` @@ -507,7 +510,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -525,14 +528,14 @@ Defines the virtual products to add to the cart. | 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_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [VirtualProductCartItemInput] } ``` @@ -547,7 +550,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -565,9 +568,9 @@ Contains the resultant wish list and any error information. | 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. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#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. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -591,21 +594,21 @@ Contains information for each filterable option (such as price, category `UID`, | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](types-q-s.md#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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example ```json { - "attribute_code": "abc123", - "count": 987, - "label": "abc123", + "attribute_code": "xyz789", + "count": 123, + "label": "xyz789", "options": [AggregationOption], - "position": 987 + "position": 123 } ``` @@ -619,16 +622,16 @@ An implementation of `AggregationOptionInterface`. | 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example ```json { "count": 123, - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -643,9 +646,9 @@ Defines aggregation option 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -657,7 +660,7 @@ Defines aggregation option fields. ```json { - "count": 123, + "count": 987, "label": "xyz789", "value": "abc123" } @@ -678,7 +681,7 @@ Filter category aggregations in layered navigation. #### Example ```json -{"includeDirectChildrenOnly": false} +{"includeDirectChildrenOnly": true} ``` @@ -708,13 +711,13 @@ An input object that specifies the filters used in product aggregations. | 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 | +| `code` - [`String`](types-q-s.md#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 | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -741,15 +744,15 @@ Apple Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example ```json { - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "abc123", "paypal_order_id": "xyz789" } @@ -765,7 +768,7 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example @@ -783,17 +786,17 @@ Contains an applied gift card with applied and remaining balance. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "applied_balance": Money, - "code": "abc123", + "code": "xyz789", "current_balance": Money, "expiration_date": "abc123" } @@ -809,8 +812,8 @@ Contains the applied and current balances. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](types-k-p.md#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 @@ -833,15 +836,15 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | #### Example ```json { "cart_id": "xyz789", - "coupon_code": "abc123" + "coupon_code": "xyz789" } ``` @@ -855,7 +858,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -892,16 +895,16 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](types-q-s.md#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"], + "cart_id": "abc123", + "coupon_codes": ["abc123"], "type": "APPEND" } ``` @@ -916,14 +919,14 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_card_code": "xyz789" } ``` @@ -938,7 +941,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -956,7 +959,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -974,7 +977,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -992,7 +995,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -1010,13 +1013,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | 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. | +| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 123, "search_term": "abc123"} +{"radius": 123, "search_term": "xyz789"} ``` @@ -1029,7 +1032,7 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | | `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | #### Example @@ -1048,12 +1051,12 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](types-q-s.md#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. | +| `attribute_type` - [`String`](types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example @@ -1118,17 +1121,17 @@ An input object that specifies the filters used for attributes. ```json { "is_comparable": true, - "is_filterable": false, + "is_filterable": true, "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_searchable": false, + "is_used_for_customer_segment": true, + "is_used_for_price_rules": false, "is_used_for_promo_rules": true, "is_visible_in_advanced_search": true, - "is_visible_on_front": true, - "is_wysiwyg_enabled": false, - "used_in_product_listing": true + "is_visible_on_front": false, + "is_wysiwyg_enabled": true, + "used_in_product_listing": false } ``` @@ -1175,15 +1178,15 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | #### Example ```json { "attribute_code": "xyz789", - "entity_type": "xyz789" + "entity_type": "abc123" } ``` @@ -1197,7 +1200,7 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example @@ -1215,28 +1218,28 @@ Base EAV implementation of CustomAttributeMetadataInterface. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#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_class` - [`String`](types-q-s.md#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. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example ```json { "code": "4", - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "abc123", "frontend_input": "BOOLEAN", "is_required": true, - "is_unique": false, - "label": "xyz789", + "is_unique": true, + "label": "abc123", "options": [CustomAttributeOptionInterface] } ``` @@ -1251,14 +1254,14 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example ```json { - "message": "xyz789", + "message": "abc123", "type": "ENTITY_NOT_FOUND" } ``` @@ -1294,15 +1297,15 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](types-q-s.md#string) | The attribute option value. | #### Example ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -1317,15 +1320,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example ```json { "is_default": false, - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -1338,14 +1341,14 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -1358,8 +1361,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1371,7 +1374,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -1384,14 +1387,14 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example ```json { - "code": "4", + "code": 4, "selected_options": [AttributeSelectedOptionInterface] } ``` @@ -1404,16 +1407,13 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The attribute value. | #### Example ```json -{ - "code": "4", - "value": "xyz789" -} +{"code": 4, "value": "abc123"} ``` @@ -1426,17 +1426,17 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#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. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "selected_options": [AttributeInputSelectedOption], - "value": "abc123" + "value": "xyz789" } ``` @@ -1448,7 +1448,7 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1474,7 +1474,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1496,7 +1496,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1517,13 +1517,13 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | #### Example ```json -{"code": "AFN", "symbol": "xyz789"} +{"code": "AFN", "symbol": "abc123"} ``` @@ -1536,17 +1536,17 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `title` - [`String!`](types-q-s.md#string) | The payment method title. | #### Example ```json { - "code": "xyz789", - "is_deferred": true, - "title": "xyz789" + "code": "abc123", + "is_deferred": false, + "title": "abc123" } ``` @@ -1560,16 +1560,16 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1578,9 +1578,9 @@ Contains details about the possible shipping methods and carriers. "amount": Money, "available": true, "base_amount": Money, - "carrier_code": "xyz789", + "carrier_code": "abc123", "carrier_title": "abc123", - "error_message": "abc123", + "error_message": "xyz789", "method_code": "xyz789", "method_title": "abc123", "price_excl_tax": Money, @@ -1616,8 +1616,8 @@ Defines the billing address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](types-f-i.md#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. | @@ -1627,7 +1627,7 @@ Defines the billing address. { "address": CartAddressInput, "customer_address_id": 123, - "same_as_shipping": true, + "same_as_shipping": false, "use_for_shipping": true } ``` @@ -1642,45 +1642,45 @@ Contains details about the billing address. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](types-c-e.md#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. | +| `customer_notes` - [`String`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_notes": "xyz789", - "fax": "abc123", - "firstname": "xyz789", + "customer_notes": "abc123", + "fax": "xyz789", + "firstname": "abc123", "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", "uid": "abc123", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -1704,15 +1704,15 @@ true | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `device_data` - [`String`](types-q-s.md#string) | | +| `public_hash` - [`String!`](types-q-s.md#string) | | #### Example ```json { "device_data": "xyz789", - "public_hash": "xyz789" + "public_hash": "abc123" } ``` @@ -1724,17 +1724,17 @@ true | 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. | +| `device_data` - [`String`](types-q-s.md#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. | +| `payment_method_nonce` - [`String!`](types-q-s.md#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" + "device_data": "xyz789", + "is_active_payment_token_enabler": true, + "payment_method_nonce": "xyz789" } ``` @@ -1746,15 +1746,15 @@ true | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `device_data` - [`String`](types-q-s.md#string) | | +| `public_hash` - [`String!`](types-q-s.md#string) | | #### Example ```json { - "device_data": "xyz789", - "public_hash": "xyz789" + "device_data": "abc123", + "public_hash": "abc123" } ``` @@ -1768,22 +1768,22 @@ Contains details about an individual category that comprises a breadcrumb. | 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. | +| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](types-f-i.md#int) | The category level. | +| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | #### Example ```json { - "category_id": 987, - "category_level": 123, + "category_id": 123, + "category_level": 987, "category_name": "abc123", - "category_uid": "4", - "category_url_key": "abc123", + "category_uid": 4, + "category_url_key": "xyz789", "category_url_path": "abc123" } ``` @@ -1798,23 +1798,23 @@ An implementation for bundle product cart items. | 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.)* | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#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_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1828,7 +1828,7 @@ An implementation for bundle product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "abc123", - "is_available": true, + "is_available": false, "max_qty": 123.45, "min_qty": 987.65, "note_from_buyer": [ItemNote], @@ -1850,14 +1850,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -1867,7 +1867,7 @@ Defines bundle product options for `CreditMemoItemInterface`. "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 123.45 @@ -1884,14 +1884,14 @@ Defines bundle product options for `InvoiceItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1903,7 +1903,7 @@ Defines bundle product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 987.65 } ``` @@ -1918,15 +1918,15 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](types-f-i.md#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 | +| `position` - [`Int`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](types-k-p.md#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. | +| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example @@ -1934,12 +1934,12 @@ Defines an individual item within a bundle product. { "option_id": 123, "options": [BundleItemOption], - "position": 987, + "position": 123, "price_range": PriceRange, - "required": false, - "sku": "abc123", - "title": "xyz789", - "type": "xyz789", + "required": true, + "sku": "xyz789", + "title": "abc123", + "type": "abc123", "uid": "4" } ``` @@ -1955,30 +1955,30 @@ Defines the characteristics that comprise a specific bundle item and its options | 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)* | +| `id` - [`Int`](types-f-i.md#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. | +| `label` - [`String`](types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": false, + "can_change_quantity": true, "id": 987, "is_default": false, - "label": "xyz789", - "position": 123, - "price": 123.45, + "label": "abc123", + "position": 987, + "price": 987.65, "price_type": "FIXED", "product": ProductInterface, - "qty": 987.65, + "qty": 123.45, "quantity": 987.65, "uid": "4" } @@ -1994,17 +1994,17 @@ Defines the input for a bundle option. | 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. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | #### Example ```json { - "id": 987, + "id": 123, "quantity": 123.45, - "value": ["xyz789"] + "value": ["abc123"] } ``` @@ -2018,27 +2018,27 @@ Defines bundle product options for `OrderItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -2046,7 +2046,7 @@ Defines bundle product options for `OrderItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -2056,15 +2056,15 @@ Defines bundle product options for `OrderItemInterface`. "product_sale_price": Money, "product_sku": "abc123", "product_type": "xyz789", - "product_url_key": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -2078,71 +2078,71 @@ Defines basic features of a bundle product and contains multiple BundleItems. | 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. | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#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. | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#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. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2153,14 +2153,14 @@ Defines basic features of a bundle product and contains multiple BundleItems. "categories": [CategoryInterface], "color": 123, "country_of_manufacture": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "dynamic_price": false, - "dynamic_sku": false, + "dynamic_price": true, + "dynamic_sku": true, "dynamic_weight": true, - "gift_message_available": "xyz789", + "gift_message_available": "abc123", "id": 123, "image": ProductImage, "is_returnable": "abc123", @@ -2172,11 +2172,11 @@ Defines basic features of a bundle product and contains multiple BundleItems. "meta_keyword": "abc123", "meta_title": "abc123", "name": "abc123", - "new_from_date": "xyz789", + "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price": ProductPrices, "price_details": PriceDetails, "price_range": PriceRange, @@ -2184,35 +2184,35 @@ Defines basic features of a bundle product and contains multiple BundleItems. "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "xyz789", + "relative_url": "abc123", "review_count": 123, "reviews": ProductReviews, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 987.65, - "special_to_date": "xyz789", + "special_to_date": "abc123", "staged": true, "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", - "uid": 4, + "type_id": "abc123", + "uid": "4", "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -2227,8 +2227,8 @@ Defines a single bundle product. | 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -2250,11 +2250,11 @@ Contains details about bundle products added to a requisition list. | 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. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2263,8 +2263,8 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -2278,13 +2278,13 @@ Defines bundle product options for `ShipmentItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example @@ -2293,7 +2293,7 @@ Defines bundle product options for `ShipmentItemInterface`. "bundle_options": [ItemSelectedBundleOption], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_shipped": 987.65 @@ -2310,23 +2310,23 @@ Defines bundle product options for `WishlistItemInterface`. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": 4, + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -2340,11 +2340,11 @@ Defines bundle product options for `WishlistItemInterface`. | 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 | +| `color` - [`String`](types-q-s.md#string) | The button color | +| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](types-q-s.md#string) | The button label | +| `layout` - [`String`](types-q-s.md#string) | The button layout | +| `shape` - [`String`](types-q-s.md#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 | @@ -2355,10 +2355,10 @@ Defines bundle product options for `WishlistItemInterface`. "color": "abc123", "height": 987, "label": "abc123", - "layout": "xyz789", - "shape": "abc123", - "tagline": false, - "use_default_height": false + "layout": "abc123", + "shape": "xyz789", + "tagline": true, + "use_default_height": true } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md index 5f077a9c4..b611d5de6 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md @@ -8,14 +8,14 @@ Specifies the quote template id of the quote template to cancel | 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. | +| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "cancellation_comment": "xyz789", + "cancellation_comment": "abc123", "template_id": "4" } ``` @@ -30,8 +30,8 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](#id) | Order ID. | -| `reason` - [`String!`](#string) | Cancellation reason. | +| `order_id` - [`ID!`](types-f-i.md#id) | Order ID. | +| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | #### Example @@ -49,7 +49,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | #### Example @@ -69,7 +69,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](#string) | | +| `description` - [`String!`](types-q-s.md#string) | | #### Example @@ -86,20 +86,20 @@ Contains the updated customer order and error message if any. | 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 | +| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](types-q-s.md#string) | Name on the card | #### Example ```json { "bin_details": CardBin, - "card_expiry_month": "xyz789", + "card_expiry_month": "abc123", "card_expiry_year": "xyz789", "last_digits": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -111,12 +111,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `bin` - [`String`](types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "abc123"} +{"bin": "xyz789"} ``` @@ -129,27 +129,27 @@ Contains the contents and other details about a guest or customer cart. | 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. | +| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](types-a-b.md#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. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -163,16 +163,16 @@ Contains the contents and other details about a guest or customer cart. "available_gift_wrappings": [GiftWrapping], "available_payment_methods": [AvailablePaymentMethod], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "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": false, + "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 987.65 @@ -189,8 +189,8 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `code` - [`String!`](types-q-s.md#string) | The country code. | +| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | #### Example @@ -211,44 +211,44 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "abc123", "custom_attributes": [AttributeValueInput], - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", "postcode": "abc123", "prefix": "xyz789", - "region": "xyz789", + "region": "abc123", "region_id": 987, "save_in_address_book": false, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", "vat_id": "xyz789" } ``` @@ -261,42 +261,42 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | +| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | #### Example ```json { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "fax": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "abc123", "region": CartAddressRegion, @@ -318,15 +318,15 @@ Contains details about the region in a billing or shipping address. | 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`](types-q-s.md#string) | The state or province code. | +| `label` - [`String`](types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "label": "xyz789", "region_id": 987 } @@ -342,15 +342,15 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | #### Example ```json { "amount": Money, - "label": ["abc123"] + "label": ["xyz789"] } ``` @@ -380,12 +380,12 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | #### Example ```json -{"code": "UNDEFINED", "message": "xyz789"} +{"code": "UNDEFINED", "message": "abc123"} ``` @@ -417,10 +417,10 @@ Defines an item to be added to the cart. | 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. | +| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | #### Example @@ -428,7 +428,7 @@ Defines an item to be added to the cart. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 987.65, + "quantity": 123.45, "selected_options": [4], "sku": "xyz789" } @@ -446,27 +446,27 @@ An interface for products in a cart. |------------|-------------| | `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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | +| [`SimpleCartItem`](types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | +| [`BundleCartItem`](types-a-b.md#bundlecartitem) | +| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | #### Example @@ -475,15 +475,15 @@ An interface for products in a cart. "discount": [Discount], "errors": [CartItemError], "id": "abc123", - "is_available": false, + "is_available": true, "max_qty": 123.45, - "min_qty": 987.65, + "min_qty": 123.45, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -498,12 +498,12 @@ Contains details about the price of the item, including taxes and discounts. | 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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -529,13 +529,13 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | 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`.)* | +| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart_item_id": 123, "quantity": 987.65} +{"cart_item_id": 987, "quantity": 123.45} ``` @@ -548,16 +548,16 @@ Contains details about the price of a selected customizable value. | 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. | +| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](types-f-i.md#float) | A price value. | #### Example ```json { "type": "FIXED", - "units": "xyz789", + "units": "abc123", "value": 987.65 } ``` @@ -572,12 +572,12 @@ A single item to be updated. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | #### Example @@ -588,7 +588,7 @@ A single item to be updated. "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": 4, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -601,8 +601,8 @@ A single item to be updated. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | #### Example @@ -610,7 +610,7 @@ A single item to be updated. { "items": [CartItemInterface], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -627,11 +627,11 @@ Contains details about the final price of items in the cart, including discount | `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. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -658,8 +658,8 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | #### Example @@ -681,7 +681,7 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -745,29 +745,29 @@ Swatch attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](types-q-s.md#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. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example @@ -775,26 +775,26 @@ Swatch attribute metadata. { "apply_to": ["SIMPLE"], "code": 4, - "default_value": "abc123", + "default_value": "xyz789", "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_comparable": false, + "is_filterable": true, + "is_filterable_in_search": false, + "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": false, + "is_used_for_price_rules": false, + "is_used_for_promo_rules": true, "is_visible_in_advanced_search": false, "is_visible_on_front": true, - "is_wysiwyg_enabled": true, - "label": "abc123", + "is_wysiwyg_enabled": false, + "label": "xyz789", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", - "update_product_preview_image": false, + "update_product_preview_image": true, "use_product_image_for_swatch": true, "used_in_product_listing": true } @@ -810,13 +810,13 @@ Defines the filters to be used in the search. A filter contains at least one att | 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. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -842,39 +842,39 @@ Contains the full set of attributes that can be returned in a category search. | 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) | | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -887,38 +887,38 @@ Contains the full set of attributes that can be returned in a category search. ```json { "automatic_sorting": "xyz789", - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", + "canonical_url": "xyz789", "children_count": "abc123", "cms_block": CmsBlock, - "created_at": "abc123", - "custom_layout_update_file": "abc123", + "created_at": "xyz789", + "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", "description": "abc123", - "display_mode": "abc123", - "filter_price_range": 987.65, + "display_mode": "xyz789", + "filter_price_range": 123.45, "id": 987, - "image": "xyz789", + "image": "abc123", "include_in_menu": 123, - "is_anchor": 123, + "is_anchor": 987, "landing_page": 987, "level": 987, - "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", - "path": "xyz789", + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "path": "abc123", "path_in_store": "xyz789", "position": 987, - "product_count": 123, + "product_count": 987, "products": CategoryProducts, - "staged": false, + "staged": true, "uid": 4, - "updated_at": "abc123", - "url_key": "abc123", + "updated_at": "xyz789", + "url_key": "xyz789", "url_path": "xyz789", - "url_suffix": "xyz789" + "url_suffix": "abc123" } ``` @@ -932,9 +932,9 @@ Contains details about the products assigned to a category. | 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. | +| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -957,8 +957,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -966,7 +966,7 @@ Contains a collection of `CategoryTree` objects and pagination information. { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -980,85 +980,85 @@ Contains the hierarchy of categories. | 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. | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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) | | +| `children_count` - [`String`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "automatic_sorting": "xyz789", - "available_sort_by": ["abc123"], + "automatic_sorting": "abc123", + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", + "canonical_url": "xyz789", "children": [CategoryTree], "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "xyz789", "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", - "description": "abc123", + "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 987.65, "id": 123, - "image": "xyz789", + "image": "abc123", "include_in_menu": 123, "is_anchor": 123, "landing_page": 987, - "level": 987, - "meta_description": "abc123", + "level": 123, + "meta_description": "xyz789", "meta_keywords": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "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, + "relative_url": "abc123", + "staged": false, "type": "CMS_PAGE", - "uid": "4", - "updated_at": "xyz789", - "url_key": "xyz789", - "url_path": "xyz789", - "url_suffix": "abc123" + "uid": 4, + "updated_at": "abc123", + "url_key": "abc123", + "url_path": "abc123", + "url_suffix": "xyz789" } ``` @@ -1072,23 +1072,23 @@ Defines details about an individual checkout agreement. | 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. | +| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](types-a-b.md#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. | +| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | #### Example ```json { - "agreement_id": 987, - "checkbox_text": "abc123", + "agreement_id": 123, + "checkbox_text": "xyz789", "content": "xyz789", "content_height": "abc123", - "is_html": true, + "is_html": false, "mode": "AUTO", "name": "xyz789" } @@ -1124,8 +1124,8 @@ An error encountered while adding an item to the cart. | 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 | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](types-q-s.md#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 @@ -1133,7 +1133,7 @@ An error encountered while adding an item to the cart. { "code": "REORDER_NOT_AVAILABLE", "message": "xyz789", - "path": ["xyz789"] + "path": ["abc123"] } ``` @@ -1167,7 +1167,7 @@ Contains details about errors encountered when a customer clear cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | | `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example @@ -1205,12 +1205,12 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Cart` object. | #### Example ```json -{"uid": 4} +{"uid": "4"} ``` @@ -1246,12 +1246,12 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example ```json -{"cart": Cart, "status": false} +{"cart": Cart, "status": true} ``` @@ -1262,9 +1262,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -1283,7 +1283,7 @@ Contains details about a failed close operation on a negotiable quote. | 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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1302,7 +1302,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1321,12 +1321,12 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -1339,10 +1339,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | 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 | +| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1367,9 +1367,9 @@ Contains details about a specific CMS block. | 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. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | #### Example @@ -1377,7 +1377,7 @@ Contains details about a specific CMS block. { "content": "xyz789", "identifier": "abc123", - "title": "xyz789" + "title": "abc123" } ``` @@ -1409,30 +1409,30 @@ Contains details about a CMS page. | 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`. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { - "content": "abc123", - "content_heading": "abc123", + "content": "xyz789", + "content_heading": "xyz789", "identifier": "abc123", - "meta_description": "abc123", - "meta_keywords": "xyz789", - "meta_title": "abc123", - "page_layout": "abc123", + "meta_description": "xyz789", + "meta_keywords": "abc123", + "meta_title": "xyz789", + "page_layout": "xyz789", "redirect_code": 123, "relative_url": "abc123", "title": "abc123", @@ -1449,7 +1449,7 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -1486,7 +1486,7 @@ Specifies which field to sort on, and whether to return the results in ascending | 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. | +| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1508,13 +1508,13 @@ Contains the output schema for a 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](types-f-i.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](types-q-s.md#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. | @@ -1522,7 +1522,7 @@ Contains the output schema for a company. | `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. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1532,12 +1532,12 @@ Contains the output schema for a company. "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "xyz789", + "email": "abc123", "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "abc123", "name": "abc123", - "payment_methods": ["xyz789"], + "payment_methods": ["abc123"], "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, @@ -1546,7 +1546,7 @@ Contains the output schema for a company. "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } ``` @@ -1561,9 +1561,9 @@ Contains details about the access control list settings of a resource. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | #### Example @@ -1571,8 +1571,8 @@ Contains details about the access control list settings of a resource. { "children": [CompanyAclResource], "id": 4, - "sort_order": 123, - "text": "xyz789" + "sort_order": 987, + "text": "abc123" } ``` @@ -1586,21 +1586,21 @@ Defines the input schema for creating a company administrator. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | #### Example ```json { - "email": "abc123", - "firstname": "abc123", - "gender": 123, + "email": "xyz789", + "firstname": "xyz789", + "gender": 987, "job_title": "xyz789", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -1614,9 +1614,9 @@ The minimal required information to identify and display the company. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | #### Example @@ -1639,24 +1639,24 @@ Defines the input schema for creating a new company. | 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. | +| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { "company_admin": CompanyAdminInput, - "company_email": "xyz789", - "company_name": "xyz789", + "company_email": "abc123", + "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, "legal_name": "abc123", - "reseller_id": "abc123", - "vat_tax_id": "abc123" + "reseller_id": "xyz789", + "vat_tax_id": "xyz789" } ``` @@ -1670,9 +1670,9 @@ Contains company credit balances and limits. | 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. | +| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](types-k-p.md#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 @@ -1695,8 +1695,8 @@ Contains details about prior company credit operations. | 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. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1718,15 +1718,15 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](types-q-s.md#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. | +| `updated_by` - [`String`](types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "custom_reference_number": "abc123", + "custom_reference_number": "xyz789", "operation_type": "ALLOCATION", "updated_by": "xyz789" } @@ -1742,10 +1742,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `amount` - [`Money`](types-k-p.md#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. | +| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](types-q-s.md#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. | @@ -1755,8 +1755,8 @@ Contains details about a single company credit operation. { "amount": Money, "balance": CompanyCredit, - "custom_reference_number": "xyz789", - "date": "xyz789", + "custom_reference_number": "abc123", + "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser } @@ -1793,13 +1793,13 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](types-q-s.md#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"} +{"name": "abc123", "type": "CUSTOMER"} ``` @@ -1829,16 +1829,16 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | +| `code` - [`String!`](types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "code": "xyz789", - "role_id": 4, + "code": "abc123", + "role_id": "4", "user": CompanyInvitationUserInput } ``` @@ -1853,7 +1853,7 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example @@ -1871,11 +1871,11 @@ Company user attributes in the invitation. | 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. | +| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | #### Example @@ -1883,9 +1883,9 @@ Company user attributes in the invitation. { "company_id": 4, "customer_id": "4", - "job_title": "xyz789", + "job_title": "abc123", "status": "ACTIVE", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1899,23 +1899,23 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegion, "street": ["abc123"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1929,12 +1929,12 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](types-q-s.md#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. | +| `postcode` - [`String!`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -1942,7 +1942,7 @@ Defines the input schema for defining a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["xyz789"], "telephone": "xyz789" @@ -1959,20 +1959,20 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput, "street": ["xyz789"], "telephone": "xyz789" @@ -1989,19 +1989,19 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#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. | +| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { "id": "4", - "name": "xyz789", + "name": "abc123", "permissions": [CompanyAclResource], - "users_count": 123 + "users_count": 987 } ``` @@ -2015,14 +2015,14 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "name": "abc123", + "name": "xyz789", "permissions": ["xyz789"] } ``` @@ -2037,17 +2037,17 @@ Defines the input schema for updating a company role. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "id": "4", - "name": "abc123", - "permissions": ["xyz789"] + "id": 4, + "name": "xyz789", + "permissions": ["abc123"] } ``` @@ -2062,8 +2062,8 @@ Contains an array of roles. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2085,16 +2085,16 @@ Contains details about a company sales representative. | 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { "email": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "abc123" } ``` @@ -2145,8 +2145,8 @@ Defines an individual node in the company structure. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example @@ -2154,7 +2154,7 @@ Defines an individual node in the company structure. { "entity": CompanyTeam, "id": "4", - "parent_id": "4" + "parent_id": 4 } ``` @@ -2168,16 +2168,13 @@ Defines the input schema for updating the company structure. | 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. | +| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{ - "parent_tree_id": "4", - "tree_id": "4" -} +{"parent_tree_id": 4, "tree_id": "4"} ``` @@ -2190,19 +2187,19 @@ Describes a company team. | 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 | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | #### Example ```json { - "description": "abc123", - "id": 4, - "name": "abc123", - "structure_id": "4" + "description": "xyz789", + "id": "4", + "name": "xyz789", + "structure_id": 4 } ``` @@ -2216,15 +2213,15 @@ Defines the input schema for creating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "name": "xyz789", "target_id": 4 } @@ -2240,17 +2237,17 @@ Defines the input schema for updating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | #### Example ```json { "description": "abc123", - "id": "4", - "name": "abc123" + "id": 4, + "name": "xyz789" } ``` @@ -2264,22 +2261,22 @@ Defines the input schema for updating a company. | 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. | +| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "company_email": "abc123", + "company_email": "xyz789", "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "xyz789", - "reseller_id": "abc123", + "legal_name": "abc123", + "reseller_id": "xyz789", "vat_tax_id": "xyz789" } ``` @@ -2294,26 +2291,26 @@ Defines the input schema for creating a company user. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](types-f-i.md#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. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", - "firstname": "abc123", - "job_title": "xyz789", + "email": "abc123", + "firstname": "xyz789", + "job_title": "abc123", "lastname": "abc123", "role_id": 4, "status": "ACTIVE", - "target_id": "4", + "target_id": 4, "telephone": "abc123" } ``` @@ -2347,23 +2344,23 @@ Defines the input schema for updating a company user. | 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. | +| `email` - [`String`](types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](types-f-i.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "firstname": "abc123", "id": "4", - "job_title": "xyz789", + "job_title": "abc123", "lastname": "abc123", "role_id": 4, "status": "ACTIVE", @@ -2382,8 +2379,8 @@ Contains details about company users. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | #### Example @@ -2423,8 +2420,8 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | #### Example @@ -2445,9 +2442,9 @@ Defines an object used to iterate through items for product comparisons. | 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. | +| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2455,7 +2452,7 @@ Defines an object used to iterate through items for product comparisons. { "attributes": [ProductAttribute], "product": ProductInterface, - "uid": "4" + "uid": 4 } ``` @@ -2470,18 +2467,18 @@ Contains iterable information such as the array of items, the count, and attribu | 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. | +| `item_count` - [`Int!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } ``` @@ -2493,12 +2490,12 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | #### Example ```json -{"html": "xyz789"} +{"html": "abc123"} ``` @@ -2511,10 +2508,10 @@ Contains details about a configurable product attribute option. | 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. | +| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example @@ -2522,7 +2519,7 @@ Contains details about a configurable product attribute option. { "code": "abc123", "label": "xyz789", - "uid": 4, + "uid": "4", "value_index": 987 } ``` @@ -2537,24 +2534,24 @@ An implementation for configurable product cart items. | 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. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2568,9 +2565,9 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", - "is_available": false, - "max_qty": 123.45, + "id": "abc123", + "is_available": true, + "max_qty": 987.65, "min_qty": 123.45, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], @@ -2591,15 +2588,15 @@ Describes configurable options that have been selected and can be selected as a | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { - "attribute_code": "abc123", - "option_value_uids": ["4"] + "attribute_code": "xyz789", + "option_value_uids": [4] } ``` @@ -2613,96 +2610,96 @@ Defines basic features of a configurable product and its simple product variants | 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. | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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.)* | +| `color` - [`Int`](types-f-i.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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 | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { "attribute_set_id": 987, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 987, + "color": 123, "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": "xyz789", + "gift_message_available": "abc123", "id": 123, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "manufacturer": 987, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "name": "xyz789", "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "xyz789", @@ -2710,8 +2707,8 @@ Defines basic features of a configurable product and its simple product variants "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "rating_summary": 123.45, - "redirect_code": 987, + "rating_summary": 987.65, + "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "abc123", "review_count": 987, @@ -2719,27 +2716,27 @@ Defines basic features of a configurable product and its simple product variants "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 987.65, - "special_to_date": "abc123", - "staged": false, + "special_to_date": "xyz789", + "staged": true, "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": 4, - "updated_at": "abc123", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", - "url_path": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "variants": [ConfigurableVariant], "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -2753,8 +2750,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](types-q-s.md#string) | Deprecated. Use `CartItemInput.sku` instead. | #### Example @@ -2763,7 +2760,7 @@ Defines basic features of a configurable product and its simple product variants "customizable_options": [CustomizableOptionInput], "data": CartItemInput, "parent_sku": "xyz789", - "variant_sku": "abc123" + "variant_sku": "xyz789" } ``` @@ -2777,18 +2774,18 @@ Contains details about configurable product options. | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](types-f-i.md#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": "abc123", - "label": "xyz789", - "uid": 4, + "attribute_code": "xyz789", + "label": "abc123", + "uid": "4", "values": [ConfigurableProductOptionValue] } ``` @@ -2803,21 +2800,21 @@ Defines a value for a configurable product option. | 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. | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | #### Example ```json { - "is_available": true, - "is_use_default": false, - "label": "xyz789", + "is_available": false, + "is_use_default": true, + "label": "abc123", "swatch": SwatchDataInterface, - "uid": 4 + "uid": "4" } ``` @@ -2831,16 +2828,16 @@ Defines configurable attributes for the specified 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](types-a-b.md#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 @@ -2851,11 +2848,11 @@ Defines configurable attributes for the specified product. "attribute_id": "xyz789", "attribute_id_v2": 123, "attribute_uid": 4, - "id": 987, - "label": "abc123", - "position": 987, + "id": 123, + "label": "xyz789", + "position": 123, "product_id": 987, - "uid": "4", + "uid": 4, "use_default": true, "values": [ConfigurableProductOptionsValues] } @@ -2872,9 +2869,9 @@ Contains metadata corresponding to the selected configurable options. | 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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#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. | +| `variant` - [`SimpleProduct`](types-q-s.md#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 @@ -2899,20 +2896,20 @@ Contains the index number assigned to a configurable product option. | 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.)* | +| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "default_label": "xyz789", - "label": "xyz789", + "default_label": "abc123", + "label": "abc123", "store_label": "abc123", "swatch_data": SwatchDataInterface, "uid": "4", @@ -2931,11 +2928,11 @@ Contains details about configurable products added to a requisition list. | 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. | +| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2944,7 +2941,7 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` @@ -2960,7 +2957,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -2981,29 +2978,29 @@ A configurable product wish list 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", - "child_sku": "abc123", + "added_at": "xyz789", + "child_sku": "xyz789", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -3017,8 +3014,8 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | #### Example @@ -3056,19 +3053,19 @@ List of account confirmation statuses. | 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. | +| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | #### Example ```json { - "comment": "abc123", + "comment": "xyz789", "email": "xyz789", "name": "xyz789", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -3082,12 +3079,12 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example ```json -{"status": true} +{"status": false} ``` @@ -3100,7 +3097,7 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example @@ -3118,7 +3115,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3136,9 +3133,9 @@ Contains the source and target wish lists after copying products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3158,20 +3155,20 @@ Contains the source and target wish lists after copying products. | 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. | +| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "xyz789", + "full_name_english": "xyz789", + "full_name_locale": "abc123", "id": "abc123", "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" @@ -3522,7 +3519,7 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example @@ -3540,14 +3537,14 @@ Defines a new gift registry. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3558,7 +3555,7 @@ Defines a new gift registry. ], "event_name": "xyz789", "gift_registry_type_uid": "4", - "message": "abc123", + "message": "xyz789", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -3576,7 +3573,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3592,12 +3589,12 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | #### Example ```json -{"cart_uid": 4} +{"cart_uid": "4"} ``` @@ -3626,20 +3623,20 @@ Contains the secure information used to authorize transaction. Applies to Payflo | 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. | +| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { - "response_message": "xyz789", - "result": 123, + "response_message": "abc123", + "result": 987, "result_code": 123, - "secure_token": "xyz789", + "secure_token": "abc123", "secure_token_id": "xyz789" } ``` @@ -3654,11 +3651,11 @@ Contains payment order details that are used while processing the payment order | 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 | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example @@ -3667,8 +3664,8 @@ Contains payment order details that are used while processing the payment order "cartId": "xyz789", "location": "PRODUCT_DETAIL", "methodCode": "abc123", - "paymentSource": "xyz789", - "vaultIntent": false + "paymentSource": "abc123", + "vaultIntent": true } ``` @@ -3682,19 +3679,19 @@ Contains payment order details that are used while processing the payment order | 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 | +| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example ```json { "amount": 123.45, - "currency_code": "abc123", - "id": "xyz789", + "currency_code": "xyz789", + "id": "abc123", "mp_order_id": "abc123", "status": "abc123" } @@ -3710,20 +3707,20 @@ Defines a new product review. | 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. | +| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example ```json { - "nickname": "abc123", + "nickname": "xyz789", "ratings": [ProductReviewRatingInput], "sku": "abc123", - "summary": "xyz789", + "summary": "abc123", "text": "xyz789" } ``` @@ -3738,7 +3735,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | #### Example @@ -3757,7 +3754,7 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example @@ -3776,9 +3773,9 @@ Defines a set of conditions that apply to a rule. | 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. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -3787,7 +3784,7 @@ Defines a set of conditions that apply to a rule. "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, "attribute": "GRAND_TOTAL", "operator": "MORE_THAN", - "quantity": 123 + "quantity": 987 } ``` @@ -3801,14 +3798,14 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "name": "xyz789" } ``` @@ -3823,7 +3820,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -3841,8 +3838,8 @@ Defines the name and visibility of a new wish list. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -3860,7 +3857,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -3878,19 +3875,19 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | 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. | +| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | #### Example ```json { - "cc_exp_month": 123, + "cc_exp_month": 987, "cc_exp_year": 987, - "cc_last_4": 123, - "cc_type": "abc123" + "cc_last_4": 987, + "cc_type": "xyz789" } ``` @@ -3904,10 +3901,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](types-f-i.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -3915,7 +3912,7 @@ Contains credit memo details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [CreditMemoItemInterface], "number": "abc123", "total": CreditMemoTotal @@ -3931,12 +3928,12 @@ Contains credit memo details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -3963,20 +3960,20 @@ Credit memo item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -3984,9 +3981,9 @@ Credit memo item details. ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 987.65 @@ -4003,15 +4000,15 @@ Contains credit memo price details. | 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. | +| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](types-k-p.md#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. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4037,25 +4034,25 @@ Contains credit memo price details. | 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 $. | +| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](types-q-s.md#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"], + "available_currency_codes": ["xyz789"], "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_currecy_code": "xyz789", + "default_display_currecy_symbol": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } @@ -4258,7 +4255,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | #### Example @@ -4276,36 +4273,36 @@ An interface containing fields that define the EAV attribute. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](#attributemetadata) | +| [`AttributeMetadata`](types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | #### Example ```json { "code": 4, - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_required": false, - "is_unique": true, + "is_required": true, + "is_unique": false, "label": "xyz789", "options": [CustomAttributeOptionInterface] } @@ -4319,21 +4316,21 @@ An interface containing fields that define the EAV attribute. | 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. | +| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | #### Example ```json { - "is_default": false, + "is_default": true, "label": "xyz789", "value": "xyz789" } @@ -4350,58 +4347,58 @@ Defines the customer name, addresses, and other details. | 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. | +| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](types-t-z.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | Details about a specific gift registry. | +| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#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. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](types-q-s.md#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). | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#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], - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", @@ -4409,21 +4406,21 @@ Defines the customer name, addresses, and other details. "custom_attributes": [AttributeValueInterface], "date_of_birth": "abc123", "default_billing": "abc123", - "default_shipping": "abc123", + "default_shipping": "xyz789", "dob": "abc123", - "email": "xyz789", - "firstname": "abc123", + "email": "abc123", + "firstname": "xyz789", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 987, + "group_id": 123, "id": 123, "is_subscribed": true, - "job_title": "xyz789", - "lastname": "xyz789", - "middlename": "xyz789", + "job_title": "abc123", + "lastname": "abc123", + "middlename": "abc123", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -4438,11 +4435,11 @@ Defines the customer name, addresses, and other details. "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, + "structure_id": "4", "suffix": "xyz789", - "taxvat": "abc123", + "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -4459,29 +4456,29 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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.)* | +| `country_id` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#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. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example @@ -4490,26 +4487,26 @@ Contains detailed information about a customer's billing or shipping address. "city": "abc123", "company": "xyz789", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 987, + "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", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "abc123" + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "xyz789" } ``` @@ -4523,14 +4520,14 @@ Specifies the attribute code and value of a customer address attribute. | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "xyz789" } ``` @@ -4545,15 +4542,15 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { "attribute_code": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -4567,25 +4564,25 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -4597,17 +4594,17 @@ Contains details about a billing or shipping address. "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], "custom_attributesV2": [AttributeValueInput], - "default_billing": true, + "default_billing": false, "default_shipping": true, - "fax": "xyz789", - "firstname": "abc123", + "fax": "abc123", + "firstname": "xyz789", "lastname": "xyz789", "middlename": "abc123", - "postcode": "xyz789", - "prefix": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "suffix": "xyz789", + "street": ["xyz789"], + "suffix": "abc123", "telephone": "abc123", "vat_id": "abc123" } @@ -4623,9 +4620,9 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -4633,7 +4630,7 @@ Defines the customer's state or province. { "region": "abc123", "region_code": "abc123", - "region_id": 123 + "region_id": 987 } ``` @@ -4647,9 +4644,9 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -4657,7 +4654,7 @@ Defines the customer's state or province. { "region": "abc123", "region_code": "abc123", - "region_id": 987 + "region_id": 123 } ``` @@ -4671,34 +4668,34 @@ Customer attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](types-f-i.md#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. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": 4, - "default_value": "abc123", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": false, + "is_required": true, "is_unique": true, - "label": "abc123", - "multiline_count": 987, + "label": "xyz789", + "multiline_count": 123, "options": [CustomAttributeOptionInterface], "sort_order": 123, "validate_rules": [ValidationRule] @@ -4715,36 +4712,36 @@ An input object for creating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "dob": "xyz789", - "email": "xyz789", - "firstname": "abc123", - "gender": 123, - "is_subscribed": true, - "lastname": "abc123", - "middlename": "xyz789", - "password": "abc123", + "email": "abc123", + "firstname": "xyz789", + "gender": 987, + "is_subscribed": false, + "lastname": "xyz789", + "middlename": "abc123", + "password": "xyz789", "prefix": "xyz789", "suffix": "xyz789", "taxvat": "xyz789" @@ -4761,21 +4758,21 @@ Contains details about a single downloadable product. | 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`. | +| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "date": "xyz789", + "date": "abc123", "download_url": "abc123", "order_increment_id": "abc123", - "remaining_downloads": "abc123", - "status": "xyz789" + "remaining_downloads": "xyz789", + "status": "abc123" } ``` @@ -4807,33 +4804,33 @@ An input object that assigns or updates customer attributes. | 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). | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "dob": "xyz789", "email": "xyz789", "firstname": "xyz789", "gender": 123, - "is_subscribed": true, - "lastname": "abc123", - "middlename": "xyz789", + "is_subscribed": false, + "lastname": "xyz789", + "middlename": "abc123", "password": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "suffix": "xyz789", "taxvat": "xyz789" } @@ -4849,34 +4846,34 @@ Contains details about each of the customer's orders. | 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.)* | +| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](types-q-s.md#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. | +| `email` - [`String`](types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | +| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -4884,30 +4881,30 @@ Contains details about each of the customer's orders. { "applied_coupons": [AppliedCoupon], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "created_at": "abc123", "credit_memos": [CreditMemo], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 987.65, + "grand_total": 123.45, "id": 4, - "increment_id": "abc123", + "increment_id": "xyz789", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "abc123", "order_date": "xyz789", - "order_number": "xyz789", + "order_number": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "xyz789", + "shipping_method": "abc123", + "status": "abc123", "token": "abc123", "total": OrderTotal } @@ -4923,7 +4920,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](types-q-s.md#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 @@ -4962,8 +4959,8 @@ The collection of orders that match the conditions defined in the filter. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | #### Example @@ -4985,7 +4982,7 @@ Identifies the filter to use for filtering orders. | Input Field | Description | |-------------|-------------| -| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | +| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | #### Example @@ -5021,7 +5018,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5040,8 +5037,8 @@ Contains store credit information with balance and history. | 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. | +| `current_balance` - [`Money`](types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5049,7 +5046,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -5064,8 +5061,8 @@ Lists changes to the amount of store credit available to the customer. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | #### Example @@ -5073,7 +5070,7 @@ Lists changes to the amount of store credit available to the customer. { "items": [CustomerStoreCreditHistoryItem], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5087,10 +5084,10 @@ Contains store credit history information. | 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. | +| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | #### Example @@ -5099,7 +5096,7 @@ Contains store credit history information. "action": "xyz789", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "abc123" + "date_time_changed": "xyz789" } ``` @@ -5113,7 +5110,7 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | +| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | #### Example @@ -5131,18 +5128,18 @@ An input object for updating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -5151,7 +5148,7 @@ An input object for updating a customer. "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", - "dob": "abc123", + "dob": "xyz789", "firstname": "abc123", "gender": 987, "is_subscribed": true, @@ -5159,7 +5156,7 @@ An input object for updating a customer. "middlename": "abc123", "prefix": "xyz789", "suffix": "abc123", - "taxvat": "abc123" + "taxvat": "xyz789" } ``` @@ -5173,24 +5170,24 @@ Contains information about a text area that is defined as part of a customizable | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "option_id": 987, + "option_id": 123, "product_sku": "xyz789", "required": false, "sort_order": 987, "title": "xyz789", - "uid": 4, + "uid": "4", "value": CustomizableAreaValue } ``` @@ -5205,17 +5202,17 @@ Defines the price and sku of a product whose page contains a customized text are | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "max_characters": 123, + "max_characters": 987, "price": 987.65, "price_type": "FIXED", "sku": "xyz789", @@ -5233,20 +5230,20 @@ Contains information about a set of checkbox values that are defined as part of | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 987, "required": true, - "sort_order": 987, + "sort_order": 123, "title": "xyz789", "uid": "4", "value": [CustomizableCheckboxValue] @@ -5263,23 +5260,23 @@ Defines the price and sku of a product whose page contains a customized set of c | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, + "sku": "abc123", + "sort_order": 987, "title": "xyz789", "uid": 4 } @@ -5295,20 +5292,20 @@ Contains information about a date picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": 123, - "product_sku": "abc123", + "option_id": 987, + "product_sku": "xyz789", "required": false, "sort_order": 987, "title": "abc123", @@ -5347,17 +5344,17 @@ Defines the price and sku of a product whose page contains a customized date pic | 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. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "xyz789", "type": "DATE", @@ -5375,22 +5372,22 @@ Contains information about a drop down menu that is defined as part of a customi | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 123, "required": false, - "sort_order": 123, + "sort_order": 987, "title": "abc123", - "uid": 4, + "uid": "4", "value": [CustomizableDropDownValue] } ``` @@ -5405,13 +5402,13 @@ Defines the price and sku of a product whose page contains a customized drop dow | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example @@ -5420,10 +5417,10 @@ Defines the price and sku of a product whose page contains a customized drop dow "option_type_id": 123, "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5437,24 +5434,24 @@ Contains information about a text field that is defined as part of a customizabl | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": "xyz789", - "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": 4, + "option_id": 123, + "product_sku": "abc123", + "required": true, + "sort_order": 987, + "title": "abc123", + "uid": "4", "value": CustomizableFieldValue } ``` @@ -5469,20 +5466,20 @@ Defines the price and sku of a product whose page contains a customized text fie | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { "max_characters": 987, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "uid": "4" } ``` @@ -5497,12 +5494,12 @@ Contains information about a file picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -5510,10 +5507,10 @@ Contains information about a file picker that is defined as part of a customizab ```json { "option_id": 987, - "product_sku": "xyz789", + "product_sku": "abc123", "required": true, "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": "4", "value": CustomizableFileValue } @@ -5529,13 +5526,13 @@ Defines the price and sku of a product whose page contains a customized file pic | 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. | +| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example @@ -5543,8 +5540,8 @@ Defines the price and sku of a product whose page contains a customized file pic { "file_extension": "xyz789", "image_size_x": 987, - "image_size_y": 123, - "price": 123.45, + "image_size_y": 987, + "price": 987.65, "price_type": "FIXED", "sku": "abc123", "uid": "4" @@ -5561,19 +5558,19 @@ Contains information about a multiselect that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": true, + "option_id": 987, + "required": false, "sort_order": 123, "title": "abc123", "uid": 4, @@ -5591,13 +5588,13 @@ Defines the price and sku of a product whose page contains a customized multisel | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example @@ -5606,10 +5603,10 @@ Defines the price and sku of a product whose page contains a customized multisel "option_type_id": 987, "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 987, "title": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -5623,9 +5620,9 @@ Defines a customizable 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. | +| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | #### Example @@ -5633,7 +5630,7 @@ Defines a customizable option. { "id": 123, "uid": 4, - "value_string": "xyz789" + "value_string": "abc123" } ``` @@ -5647,11 +5644,11 @@ Contains basic information about a customizable option. It can be implemented by | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -5671,10 +5668,10 @@ Contains basic information about a customizable option. It can be implemented by ```json { "option_id": 123, - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": "4" + "required": false, + "sort_order": 987, + "title": "xyz789", + "uid": 4 } ``` @@ -5694,12 +5691,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | | [`ConfigurableProduct`](#configurableproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | #### Example @@ -5717,11 +5714,11 @@ Contains information about a set of radio buttons that are defined as part of a | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example @@ -5730,9 +5727,9 @@ Contains information about a set of radio buttons that are defined as part of a { "option_id": 123, "required": false, - "sort_order": 123, - "title": "abc123", - "uid": 4, + "sort_order": 987, + "title": "xyz789", + "uid": "4", "value": [CustomizableRadioValue] } ``` @@ -5747,25 +5744,25 @@ Defines the price and sku of a product whose page contains a customized set of r | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "option_type_id": 987, - "price": 987.65, + "option_type_id": 123, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", "sort_order": 123, - "title": "abc123", - "uid": 4 + "title": "xyz789", + "uid": "4" } ``` @@ -5779,7 +5776,7 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example @@ -5797,7 +5794,7 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example @@ -5815,12 +5812,12 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -5833,7 +5830,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -5849,9 +5846,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -5870,14 +5867,14 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -5889,7 +5886,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -5908,12 +5905,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -5924,7 +5921,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example @@ -5942,9 +5939,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -5969,14 +5966,14 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example ```json { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } ``` @@ -5990,13 +5987,13 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | +| `message` - [`String`](types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"message": "abc123", "type": "UNDEFINED"} +{"message": "xyz789", "type": "UNDEFINED"} ``` @@ -6026,12 +6023,12 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example ```json -{"approval_rule_uids": ["4"]} +{"approval_rule_uids": [4]} ``` @@ -6062,7 +6059,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6080,13 +6077,13 @@ Indicates whether the request to delete the requisition list was successful. | 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. | +| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example ```json -{"requisition_lists": RequisitionLists, "status": false} +{"requisition_lists": RequisitionLists, "status": true} ``` @@ -6099,13 +6096,13 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"status": false, "wishlists": [Wishlist]} +{"status": true, "wishlists": [Wishlist]} ``` @@ -6118,13 +6115,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6135,8 +6132,8 @@ Specifies the discount type and value for quote line item. "coupon": AppliedCoupon, "is_discounting_locked": true, "label": "xyz789", - "type": "abc123", - "value": 123.45 + "type": "xyz789", + "value": 987.65 } ``` @@ -6150,21 +6147,21 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#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. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -6174,17 +6171,17 @@ An implementation for downloadable product cart items. "discount": [Discount], "errors": [CartItemError], "id": "abc123", - "is_available": false, + "is_available": true, "links": [DownloadableProductLinks], - "max_qty": 123.45, - "min_qty": 987.65, + "max_qty": 987.65, + "min_qty": 123.45, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": "4" + "uid": 4 } ``` @@ -6200,12 +6197,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -6215,10 +6212,10 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 } ``` @@ -6251,12 +6248,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6266,9 +6263,9 @@ Defines downloadable product options for `InvoiceItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 123.45 } ``` @@ -6283,17 +6280,17 @@ Defines characteristics of the links for downloadable product. | 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. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json { - "sort_order": 123, - "title": "abc123", - "uid": "4" + "sort_order": 987, + "title": "xyz789", + "uid": 4 } ``` @@ -6309,25 +6306,25 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -6335,25 +6332,25 @@ Defines downloadable product options for `OrderItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", - "product_url_key": "xyz789", + "product_sku": "abc123", + "product_type": "abc123", + "product_url_key": "abc123", "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, + "quantity_invoiced": 123.45, "quantity_ordered": 123.45, "quantity_refunded": 987.65, "quantity_returned": 987.65, - "quantity_shipped": 123.45, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -6367,77 +6364,77 @@ Defines a product that the shopper downloads. | 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. | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "abc123", + "color": 123, + "country_of_manufacture": "xyz789", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, @@ -6449,29 +6446,29 @@ Defines a product that the shopper downloads. DownloadableProductSamples ], "gift_message_available": "xyz789", - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", - "links_purchased_separately": 987, - "links_title": "abc123", - "manufacturer": 123, + "links_purchased_separately": 123, + "links_title": "xyz789", + "manufacturer": 987, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "xyz789", - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "rating_summary": 987.65, - "redirect_code": 123, + "rating_summary": 123.45, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "xyz789", "review_count": 123, @@ -6481,16 +6478,16 @@ Defines a product that the shopper downloads. "small_image": ProductImage, "special_from_date": "abc123", "special_price": 123.45, - "special_to_date": "abc123", - "staged": false, + "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": "abc123", - "uid": "4", + "type_id": "xyz789", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", @@ -6537,17 +6534,17 @@ Defines characteristics of a downloadable product. | 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.)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](types-a-b.md#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)* | +| `number_of_downloads` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example @@ -6561,9 +6558,9 @@ Defines characteristics of a downloadable product. "sample_file": "xyz789", "sample_type": "FILE", "sample_url": "xyz789", - "sort_order": 987, + "sort_order": 123, "title": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -6577,7 +6574,7 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example @@ -6595,23 +6592,23 @@ Defines characteristics of a downloadable product. | 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)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | #### Example ```json { "id": 123, - "sample_file": "abc123", + "sample_file": "xyz789", "sample_type": "FILE", "sample_url": "xyz789", - "sort_order": 987, - "title": "abc123" + "sort_order": 123, + "title": "xyz789" } ``` @@ -6625,12 +6622,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -6655,26 +6652,26 @@ A downloadable product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": "4", + "id": 4, "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples] } ``` @@ -6689,16 +6686,13 @@ Identifies a quote to be duplicated | 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. | +| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | #### Example ```json -{ - "duplicated_quote_uid": "4", - "quote_uid": 4 -} +{"duplicated_quote_uid": 4, "quote_uid": 4} ``` @@ -6711,7 +6705,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -6730,15 +6724,12 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json -{ - "content": ComplexTextValue, - "uid": "4" -} +{"content": ComplexTextValue, "uid": 4} ``` @@ -6794,8 +6785,8 @@ Contains an array of dynamic blocks. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -6803,7 +6794,7 @@ Contains an array of dynamic blocks. { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -6817,18 +6808,14 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](types-f-i.md#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" -} +{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"} ``` @@ -6841,15 +6828,15 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | +| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | #### Example ```json { "attribute_code": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -6863,16 +6850,13 @@ Defines a customer-entered option. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | #### Example ```json -{ - "uid": "4", - "value": "abc123" -} +{"uid": 4, "value": "abc123"} ``` @@ -6885,22 +6869,22 @@ Contains the `uid`, `relative_url`, and `type` attributes. | 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. | +| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { "canonical_url": "xyz789", - "entity_uid": 4, + "entity_uid": "4", "id": 987, - "redirectCode": 987, - "relative_url": "abc123", + "redirectCode": 123, + "relative_url": "xyz789", "type": "CMS_PAGE" } ``` @@ -6913,15 +6897,15 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | #### Example @@ -6940,7 +6924,7 @@ Contains details about an address. | 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. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -6962,15 +6946,15 @@ Contains details about an address. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example ```json { "address": EstimateAddressInput, - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_method": ShippingMethodInput } ``` @@ -7003,13 +6987,13 @@ Lists the exchange rate. | 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. | +| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "abc123", "rate": 987.65} +{"currency_to": "xyz789", "rate": 987.65} ``` @@ -7022,10 +7006,10 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` 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 397e4f07b..33b58c538 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 @@ -8,8 +8,8 @@ Defines a filter that matches the input exactly. | 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"]`. | +| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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 @@ -47,13 +47,13 @@ Defines a filter that performs a fuzzy search. | 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` - [`String`](types-q-s.md#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"} +{"match": "xyz789", "match_type": "FULL"} ``` @@ -66,14 +66,14 @@ Defines a filter that matches a range of values, such as prices or dates. | 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. | +| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example ```json { - "from": "xyz789", + "from": "abc123", "to": "xyz789" } ``` @@ -88,17 +88,17 @@ Defines a filter for an input string. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example ```json { - "eq": "abc123", + "eq": "xyz789", "in": ["xyz789"], - "match": "xyz789" + "match": "abc123" } ``` @@ -112,41 +112,41 @@ Defines the comparison operators that can be used in a filter. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](types-q-s.md#string) | | +| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](types-q-s.md#string) | Less than. | +| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](types-q-s.md#string) | Not null. | +| `null` - [`String`](types-q-s.md#string) | Is null. | +| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { "eq": "abc123", - "finset": ["abc123"], + "finset": ["xyz789"], "from": "abc123", "gt": "abc123", - "gteq": "abc123", + "gteq": "xyz789", "in": ["abc123"], "like": "abc123", "lt": "abc123", - "lteq": "xyz789", + "lteq": "abc123", "moreq": "xyz789", "neq": "xyz789", "nin": ["abc123"], "notnull": "abc123", "null": "xyz789", - "to": "abc123" + "to": "xyz789" } ``` @@ -160,8 +160,8 @@ A single FPT that can be applied to a product price. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example @@ -205,7 +205,7 @@ values as specified by #### Example ```json -123.45 +987.65 ``` @@ -218,12 +218,12 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example ```json -{"customer_email": "xyz789"} +{"customer_email": "abc123"} ``` @@ -236,7 +236,7 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | +| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | #### Example @@ -259,7 +259,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -277,7 +277,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": "4"} +{"negotiable_quote_uid": 4} ``` @@ -290,7 +290,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -308,9 +308,9 @@ Contains details about the gift card account. | 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. | +| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -318,7 +318,7 @@ Contains details about the gift card account. { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -332,12 +332,12 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | #### Example ```json -{"gift_card_code": "xyz789"} +{"gift_card_code": "abc123"} ``` @@ -363,10 +363,10 @@ Contains the value of a gift card, the website that generated the card, and rela { "attribute_id": 987, "uid": 4, - "value": 987.65, - "value_id": 987, + "value": 123.45, + "value_id": 123, "website_id": 987, - "website_value": 123.45 + "website_value": 987.65 } ``` @@ -380,24 +380,24 @@ Contains details about a gift card that has been added to a cart. | 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. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount and currency of the gift card. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#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. | +| `message` - [`String`](types-q-s.md#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. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#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. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -408,21 +408,21 @@ Contains details about a gift card that has been added to a cart. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "xyz789", - "is_available": false, - "max_qty": 987.65, + "id": "abc123", + "is_available": true, + "max_qty": 123.45, "message": "xyz789", - "min_qty": 123.45, + "min_qty": 987.65, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, "recipient_email": "abc123", - "recipient_name": "abc123", + "recipient_name": "xyz789", "sender_email": "xyz789", "sender_name": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -434,13 +434,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -449,11 +449,11 @@ Contains details about a gift card that has been added to a cart. { "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 123.45 } ``` @@ -466,13 +466,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -481,11 +481,11 @@ Contains details about a gift card that has been added to a cart. { "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 123.45 } ``` @@ -500,19 +500,19 @@ Contains details about a gift card. | 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. | +| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "recipient_email": "abc123", - "recipient_name": "abc123", + "recipient_name": "xyz789", "sender_email": "abc123", "sender_name": "xyz789" } @@ -528,13 +528,13 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -543,10 +543,10 @@ Contains details about the sender, recipient, and amount of a gift card. "amount": Money, "custom_giftcard_amount": Money, "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "abc123", - "sender_email": "xyz789", - "sender_name": "abc123" + "recipient_email": "abc123", + "recipient_name": "xyz789", + "sender_email": "abc123", + "sender_name": "xyz789" } ``` @@ -558,53 +558,53 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#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. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example ```json { "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "abc123", + "product_sku": "abc123", + "product_type": "xyz789", "product_url_key": "abc123", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -618,87 +618,87 @@ Defines properties of a gift card. | 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. | +| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](types-a-b.md#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. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`String`](types-q-s.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](types-q-s.md#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.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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. | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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.)* | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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_message": true, "allow_open_amount": true, - "attribute_set_id": 987, - "canonical_url": "abc123", + "attribute_set_id": 123, + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -709,54 +709,54 @@ Defines properties of a gift card. "id": 123, "image": ProductImage, "is_redeemable": false, - "is_returnable": "xyz789", - "lifetime": 123, + "is_returnable": "abc123", + "lifetime": 987, "manufacturer": 987, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 987, + "message_max_length": 123, "meta_description": "abc123", "meta_keyword": "xyz789", "meta_title": "abc123", "name": "xyz789", "new_from_date": "abc123", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, - "open_amount_max": 123.45, + "open_amount_max": 987.65, "open_amount_min": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "rating_summary": 987.65, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": false, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", - "uid": 4, - "updated_at": "abc123", + "type_id": "abc123", + "uid": "4", + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website], "weight": 987.65 } @@ -772,9 +772,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -800,10 +800,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -816,7 +816,7 @@ Contains details about gift cards added to a requisition list. "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -850,25 +850,25 @@ A single gift card added to a wish list. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "gift_card_options": GiftCardOptions, "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -882,9 +882,9 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | +| `from` - [`String!`](types-q-s.md#string) | Sender name | +| `message` - [`String!`](types-q-s.md#string) | Gift message text | +| `to` - [`String!`](types-q-s.md#string) | Recipient name | #### Example @@ -906,17 +906,17 @@ Defines a gift message. | 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. | +| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | #### Example ```json { - "from": "xyz789", - "message": "abc123", - "to": "abc123" + "from": "abc123", + "message": "xyz789", + "to": "xyz789" } ``` @@ -930,9 +930,9 @@ Contains prices for gift wrapping options. | 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. | +| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | #### Example @@ -954,15 +954,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `event_name` - [`String!`](types-q-s.md#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. | +| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](types-q-s.md#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. | +| `shipping_address` - [`CustomerAddress`](types-c-e.md#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. | @@ -973,7 +973,7 @@ Contains details about a gift registry. { "created_at": "xyz789", "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], "message": "xyz789", "owner_name": "xyz789", @@ -982,7 +982,7 @@ Contains details about a gift registry. "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } ``` @@ -996,17 +996,17 @@ Contains details about a gift registry. |------------|-------------| | `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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": "4", + "code": 4, "group": "EVENT_INFORMATION", - "label": "xyz789", - "value": "abc123" + "label": "abc123", + "value": "xyz789" } ``` @@ -1044,12 +1044,15 @@ Defines a dynamic attribute. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example ```json -{"code": 4, "value": "abc123"} +{ + "code": "4", + "value": "abc123" +} ``` @@ -1061,8 +1064,8 @@ Defines a dynamic attribute. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1075,7 +1078,7 @@ Defines a dynamic attribute. ```json { - "code": "4", + "code": 4, "label": "xyz789", "value": "xyz789" } @@ -1089,23 +1092,23 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#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", + "attribute_group": "xyz789", "code": "4", "input_type": "xyz789", "is_required": false, - "label": "xyz789", - "sort_order": 123 + "label": "abc123", + "sort_order": 987 } ``` @@ -1117,11 +1120,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1139,7 +1142,7 @@ Defines a dynamic attribute. "input_type": "xyz789", "is_required": false, "label": "xyz789", - "sort_order": 123 + "sort_order": 987 } ``` @@ -1151,9 +1154,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1162,7 +1165,7 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", + "created_at": "xyz789", "note": "xyz789", "product": ProductInterface, "quantity": 123.45, @@ -1179,9 +1182,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1197,10 +1200,10 @@ Defines a dynamic attribute. ```json { "created_at": "abc123", - "note": "abc123", + "note": "xyz789", "product": ProductInterface, "quantity": 123.45, - "quantity_fulfilled": 123.45, + "quantity_fulfilled": 987.65, "uid": "4" } ``` @@ -1215,14 +1218,14 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](types-a-b.md#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) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1246,7 +1249,7 @@ Contains details about an error that occurred when processing a gift registry it | `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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1256,7 +1259,7 @@ Contains details about an error that occurred when processing a gift registry it "code": "OUT_OF_STOCK", "gift_registry_item_uid": "4", "gift_registry_uid": 4, - "message": "xyz789", + "message": "abc123", "product_uid": "4" } ``` @@ -1297,7 +1300,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1335,9 +1338,9 @@ Contains details about a registrant. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1347,10 +1350,10 @@ Contains details about a registrant. "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "abc123", - "firstname": "xyz789", + "email": "xyz789", + "firstname": "abc123", "lastname": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1363,16 +1366,16 @@ Contains details about a registrant. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { "code": 4, - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -1386,23 +1389,23 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | +| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](types-q-s.md#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. | +| `location` - [`String`](types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](types-q-s.md#string) | The type of event being held. | #### Example ```json { "event_date": "xyz789", - "event_title": "abc123", - "gift_registry_uid": 4, + "event_title": "xyz789", + "gift_registry_uid": "4", "location": "xyz789", "name": "xyz789", - "type": "xyz789" + "type": "abc123" } ``` @@ -1416,13 +1419,16 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](types-c-e.md#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} +{ + "address_data": CustomerAddressInput, + "address_id": "4" +} ``` @@ -1455,7 +1461,7 @@ Contains details about a gift registry type. | 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. | +| `label` - [`String!`](types-q-s.md#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 @@ -1466,7 +1472,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1480,18 +1486,18 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `design` - [`String!`](types-q-s.md#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. | +| `price` - [`Money!`](types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example ```json { - "design": "abc123", - "id": 4, + "design": "xyz789", + "id": "4", "image": GiftWrappingImage, "price": Money, "uid": "4" @@ -1508,8 +1514,8 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | #### Example @@ -1528,17 +1534,17 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](#string) | The button color | +| `color` - [`String`](types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | +| `type` - [`String`](types-q-s.md#string) | The button type | #### Example ```json { "color": "abc123", - "height": 987, - "type": "abc123" + "height": 123, + "type": "xyz789" } ``` @@ -1551,13 +1557,13 @@ Points to an image associated with a gift wrapping option. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -1565,11 +1571,11 @@ Points to an image associated with a gift wrapping option. { "button_styles": GooglePayButtonStyles, "code": "abc123", - "is_visible": false, + "is_visible": true, "payment_intent": "xyz789", - "payment_source": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "title": "abc123" } ``` @@ -1584,9 +1590,9 @@ Google Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example @@ -1609,70 +1615,70 @@ Defines a grouped product, which consists of simple standalone products that are | 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. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](types-q-s.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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.)* | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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", + "attribute_set_id": 123, + "canonical_url": "xyz789", "categories": [CategoryInterface], "color": 123, "country_of_manufacture": "abc123", @@ -1688,12 +1694,12 @@ Defines a grouped product, which consists of simple standalone products that are "manufacturer": 987, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "xyz789", + "meta_title": "abc123", + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options_container": "abc123", "price": ProductPrices, @@ -1704,27 +1710,27 @@ Defines a grouped product, which consists of simple standalone products that are "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "xyz789", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "xyz789", + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "abc123", "staged": true, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", - "uid": "4", + "type_id": "abc123", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", - "url_path": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], @@ -1743,14 +1749,14 @@ Contains information about an individual grouped product item. | 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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example ```json { - "position": 123, + "position": 987, "product": ProductInterface, "qty": 987.65 } @@ -1766,11 +1772,11 @@ A grouped product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -1779,8 +1785,8 @@ A grouped product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, "quantity": 987.65 } @@ -1794,31 +1800,31 @@ A grouped product wish list item. | 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 | +| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](types-a-b.md#boolean) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "cc_vault_code": "xyz789", - "code": "xyz789", - "is_vault_enabled": true, + "code": "abc123", + "is_vault_enabled": false, "is_visible": true, - "payment_intent": "abc123", - "payment_source": "xyz789", + "payment_intent": "xyz789", + "payment_source": "abc123", "requires_card_details": true, "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds": true, "title": "abc123" } @@ -1834,15 +1840,15 @@ Hosted Fields payment inputs | 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 | +| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example @@ -1850,13 +1856,13 @@ Hosted Fields payment inputs { "cardBin": "xyz789", "cardExpiryMonth": "xyz789", - "cardExpiryYear": "xyz789", - "cardLast4": "xyz789", + "cardExpiryYear": "abc123", + "cardLast4": "abc123", "holderName": "abc123", "is_active_payment_token_enabler": false, "payment_source": "xyz789", "payments_order_id": "abc123", - "paypal_order_id": "abc123" + "paypal_order_id": "xyz789" } ``` @@ -1870,15 +1876,15 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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" + "return_url": "abc123" } ``` @@ -1892,12 +1898,12 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | #### Example ```json -{"secure_form_url": "xyz789"} +{"secure_form_url": "abc123"} ``` @@ -1910,7 +1916,7 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example @@ -1928,15 +1934,15 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | +| `name` - [`String`](types-q-s.md#string) | A parameter name. | +| `value` - [`String`](types-q-s.md#string) | A parameter value. | #### Example ```json { "name": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -1964,14 +1970,14 @@ When expected as an input type, any string (such as `"4"`) or integer | 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. | +| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json { - "thumbnail": "abc123", + "thumbnail": "xyz789", "value": "xyz789" } ``` @@ -2008,7 +2014,7 @@ values. Int can represent values between -(2^31) and 2^31 - 1. #### Example ```json -123 +987 ``` @@ -2021,12 +2027,12 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -2039,10 +2045,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#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. | +| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2050,9 +2056,9 @@ Contains invoice details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [InvoiceItemInterface], - "number": "xyz789", + "number": "abc123", "total": InvoiceTotal } ``` @@ -2065,12 +2071,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2080,10 +2086,10 @@ Contains invoice details. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -2097,20 +2103,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2123,8 +2129,8 @@ Contains detailes about invoiced items. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "product_sku": "abc123", + "quantity_invoiced": 123.45 } ``` @@ -2138,14 +2144,14 @@ Contains price details from an invoice. | 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. | +| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2172,7 +2178,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2190,12 +2196,12 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2208,12 +2214,12 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example ```json -{"is_role_name_available": false} +{"is_role_name_available": true} ``` @@ -2226,12 +2232,12 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2244,7 +2250,7 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example @@ -2262,11 +2268,11 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](types-q-s.md#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` - [`String`](types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example @@ -2275,10 +2281,10 @@ The note object for quote line item. { "created_at": "xyz789", "creator_id": 987, - "creator_type": 123, + "creator_type": 987, "negotiable_quote_item_uid": "4", "note": "xyz789", - "note_uid": 4 + "note_uid": "4" } ``` @@ -2293,7 +2299,7 @@ A list of options of the selected bundle product. | 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. | +| `label` - [`String!`](types-q-s.md#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. | @@ -2301,8 +2307,8 @@ A list of options of the selected bundle product. ```json { - "id": 4, - "label": "abc123", + "id": "4", + "label": "xyz789", "uid": 4, "values": [ItemSelectedBundleOptionValue] } @@ -2319,9 +2325,9 @@ A list of values for the selected bundle product. | 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. | +| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](types-q-s.md#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. | @@ -2329,11 +2335,11 @@ A list of values for the selected bundle product. ```json { - "id": 4, + "id": "4", "price": Money, "product_name": "xyz789", - "product_sku": "abc123", - "quantity": 987.65, + "product_sku": "xyz789", + "quantity": 123.45, "uid": "4" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md index 33ee7860d..f76a27757 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md @@ -8,8 +8,8 @@ Contains a key-value pair. | 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. | +| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | #### Example @@ -31,18 +31,18 @@ Contains information for rendering layered navigation. | 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.)* | +| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](types-q-s.md#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" + "filter_items_count": 987, + "name": "xyz789", + "request_var": "xyz789" } ``` @@ -54,15 +54,15 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example ```json { - "items_count": 123, + "items_count": 987, "label": "xyz789", "value_string": "abc123" } @@ -76,16 +76,16 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#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) | +| [`SwatchLayerFilterItem`](types-q-s.md#swatchlayerfilteritem) | #### Example @@ -93,7 +93,7 @@ Contains information for rendering layered navigation. { "items_count": 987, "label": "xyz789", - "value_string": "xyz789" + "value_string": "abc123" } ``` @@ -107,17 +107,17 @@ Sets quote item note. | 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. | +| `note` - [`String`](types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "note": "xyz789", - "quote_item_uid": 4, - "quote_uid": 4 + "quote_item_uid": "4", + "quote_uid": "4" } ``` @@ -132,14 +132,14 @@ Defines characteristics about images and videos associated with a specific produ | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -147,14 +147,14 @@ Defines characteristics about images and videos associated with a specific produ ```json { "content": ProductMediaGalleryEntriesContent, - "disabled": false, - "file": "abc123", - "id": 987, + "disabled": true, + "file": "xyz789", + "id": 123, "label": "xyz789", "media_type": "abc123", "position": 987, - "types": ["xyz789"], - "uid": "4", + "types": ["abc123"], + "uid": 4, "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -169,10 +169,10 @@ Contains basic information about a product image or video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -185,9 +185,9 @@ Contains basic information about a product image or video. ```json { - "disabled": false, + "disabled": true, "label": "abc123", - "position": 987, + "position": 123, "url": "abc123" } ``` @@ -200,12 +200,12 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{"type": "xyz789"} +{"type": "abc123"} ``` @@ -216,14 +216,14 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `layout` - [`String`](#string) | The message layout | +| `layout` - [`String`](types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "layout": "xyz789", + "layout": "abc123", "logo": MessageStyleLogo } ``` @@ -238,13 +238,13 @@ Defines a monetary value, including a numeric value and a currency code. | 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. | +| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | #### Example ```json -{"currency": "AFN", "value": 987.65} +{"currency": "AFN", "value": 123.45} ``` @@ -257,9 +257,9 @@ Contains the customer's gift registry and any errors encountered. | 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. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -281,12 +281,12 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": [4]} +{"requisitionListItemUids": ["4"]} ``` @@ -299,8 +299,8 @@ Output of the request to move items to another requisition list. | 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. | +| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -321,18 +321,14 @@ Move Line Item to Requisition List. | 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. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json -{ - "quote_item_uid": 4, - "quote_uid": "4", - "requisition_list_uid": 4 -} +{"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4} ``` @@ -363,9 +359,9 @@ Contains the source and target wish lists after moving products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -387,23 +383,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](types-q-s.md#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. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#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. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -413,12 +409,12 @@ Contains details about a negotiable quote. "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_virtual": false, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], @@ -439,14 +435,14 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | +| `code` - [`String!`](types-q-s.md#string) | The address country code. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "label": "xyz789" } ``` @@ -461,33 +457,33 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", - "country_code": "xyz789", + "country_code": "abc123", "firstname": "xyz789", "lastname": "abc123", - "postcode": "abc123", - "region": "xyz789", + "postcode": "xyz789", + "region": "abc123", "region_id": 987, - "save_in_address_book": true, + "save_in_address_book": false, "street": ["abc123"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -499,15 +495,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -523,12 +519,12 @@ Defines the billing or shipping address to be applied to the cart. "city": "xyz789", "company": "abc123", "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "xyz789", - "postcode": "abc123", + "firstname": "abc123", + "lastname": "abc123", + "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" + "street": ["abc123"], + "telephone": "abc123" } ``` @@ -542,17 +538,17 @@ Defines the company's state or province. | 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. | +| `code` - [`String`](types-q-s.md#string) | The address region code. | +| `label` - [`String`](types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "abc123", - "region_id": 123 + "region_id": 987 } ``` @@ -564,15 +560,15 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example @@ -581,7 +577,7 @@ Defines the company's state or province. "city": "xyz789", "company": "xyz789", "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", + "firstname": "xyz789", "lastname": "xyz789", "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, @@ -601,16 +597,16 @@ Defines the billing address. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", + "customer_address_uid": 4, "same_as_shipping": true, "use_for_shipping": true } @@ -627,19 +623,19 @@ Contains a single plain text comment from either the buyer or seller. | 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. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { "author": NegotiableQuoteUser, - "created_at": "xyz789", + "created_at": "abc123", "creator_type": "BUYER", - "text": "abc123", + "text": "xyz789", "uid": 4 } ``` @@ -671,12 +667,12 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | +| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | #### Example ```json -{"comment": "xyz789"} +{"comment": "abc123"} ``` @@ -689,17 +685,17 @@ Contains custom log entries added by third-party extensions. | 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. | +| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { "new_value": "abc123", - "old_value": "abc123", - "title": "abc123" + "old_value": "xyz789", + "title": "xyz789" } ``` @@ -713,8 +709,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -765,12 +761,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "abc123"} +{"comment": "xyz789"} ``` @@ -786,8 +782,8 @@ Contains details about a change for a negotiable quote. | `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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -796,7 +792,7 @@ Contains details about a change for a negotiable quote. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", + "created_at": "xyz789", "uid": 4 } ``` @@ -830,8 +826,8 @@ Contains a new expiration date and the previous date. | 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. | +| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example @@ -852,7 +848,7 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#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 @@ -933,7 +929,7 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example @@ -951,8 +947,8 @@ Specifies the updated quantity of an item. | 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. | +| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example @@ -970,8 +966,8 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -990,17 +986,17 @@ Defines the payment method to be applied to the negotiable quote. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `selected_shipping_method` - [`SelectedShippingMethod`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example @@ -1008,14 +1004,14 @@ Defines the payment method to be applied to the negotiable quote. { "available_shipping_methods": [AvailableShippingMethod], "city": "abc123", - "company": "xyz789", + "company": "abc123", "country": NegotiableQuoteAddressCountry, "firstname": "abc123", "lastname": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "abc123" } ``` @@ -1031,15 +1027,15 @@ Defines shipping addresses for the negotiable quote. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", + "customer_address_uid": 4, "customer_notes": "xyz789" } ``` @@ -1054,7 +1050,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1117,20 +1113,20 @@ Contains details about a negotiable quote template. |------------|-------------| | `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. | +| `expiration_date` - [`String!`](types-q-s.md#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. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](types-c-e.md#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. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | #### Example @@ -1144,14 +1140,14 @@ Contains details about a negotiable quote template. "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "abc123", - "template_id": 4, - "total_quantity": 123.45 + "status": "xyz789", + "template_id": "4", + "total_quantity": 987.65 } ``` @@ -1165,8 +1161,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1187,41 +1183,41 @@ Contains data for a negotiable quote template in a grid. | 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. | +| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "activated_at": "xyz789", - "company_name": "abc123", + "company_name": "xyz789", "expiration_date": "abc123", - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "last_shared_at": "xyz789", "max_order_commitment": 123, - "min_negotiated_grand_total": 123.45, - "min_order_commitment": 987, - "name": "abc123", + "min_negotiated_grand_total": 987.65, + "min_order_commitment": 123, + "name": "xyz789", "orders_placed": 123, "sales_rep_name": "xyz789", "state": "abc123", - "status": "abc123", + "status": "xyz789", "submitted_by": "abc123", - "template_id": 4 + "template_id": "4" } ``` @@ -1235,20 +1231,15 @@ Specifies the updated quantity of an 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. | +| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | #### Example ```json -{ - "item_id": "4", - "max_qty": 987.65, - "min_qty": 987.65, - "quantity": 987.65 -} +{"item_id": 4, "max_qty": 123.45, "min_qty": 987.65, "quantity": 123.45} ``` @@ -1262,8 +1253,8 @@ Defines shipping addresses for the negotiable quote template. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example @@ -1285,7 +1276,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1322,9 +1313,9 @@ Contains a list of negotiable templates that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1345,7 +1336,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1369,12 +1360,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1387,8 +1378,8 @@ A limited view of a Buyer or Seller in the negotiable quote process. | 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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | #### Example @@ -1410,9 +1401,9 @@ Contains a list of negotiable that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1435,13 +1426,13 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json -{"message": "abc123", "uid": 4} +{"message": "xyz789", "uid": 4} ``` @@ -1454,7 +1445,7 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -1472,15 +1463,15 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json { - "order_id": "xyz789", - "order_number": "abc123" + "order_id": "abc123", + "order_number": "xyz789" } ``` @@ -1494,21 +1485,21 @@ Contains detailed information about an order's billing and shipping addresses. | 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). | +| `city` - [`String!`](types-q-s.md#string) | The city or town. | +| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | +| `fax` - [`String`](types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example @@ -1517,18 +1508,18 @@ Contains detailed information about an order's billing and shipping addresses. "city": "xyz789", "company": "xyz789", "country_code": "AF", - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": "xyz789", - "region_id": "4", + "region_id": 4, "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -1542,9 +1533,9 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `number` - [`String!`](#string) | Order number. | -| `postcode` - [`String!`](#string) | Order billing address postcode. | +| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | +| `number` - [`String!`](types-q-s.md#string) | Order number. | +| `postcode` - [`String!`](types-q-s.md#string) | Order billing address postcode. | #### Example @@ -1564,26 +1555,26 @@ Input to retrieve an order based on details. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -1594,21 +1585,21 @@ Input to retrieve an order based on details. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -1622,34 +1613,34 @@ Order item details. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | +| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | +| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1661,18 +1652,18 @@ Order item details. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_canceled": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_returned": 987.65, + "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" @@ -1689,15 +1680,15 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | +| `label` - [`String!`](types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "abc123", - "value": "xyz789" + "label": "xyz789", + "value": "abc123" } ``` @@ -1712,8 +1703,8 @@ Contains details about the payment method used to pay for the order. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example @@ -1721,7 +1712,7 @@ Contains details about the payment method used to pay for the order. { "additional_data": [KeyValue], "name": "abc123", - "type": "xyz789" + "type": "abc123" } ``` @@ -1735,18 +1726,18 @@ Contains order shipment details. | 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. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [ShipmentItemInterface], "number": "abc123", "tracking": [ShipmentTracking] @@ -1763,7 +1754,7 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](#string) | Order token. | +| `token` - [`String!`](types-q-s.md#string) | Order token. | #### Example @@ -1782,11 +1773,11 @@ Contains details about the sales total amounts used to calculate the final price | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#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. | @@ -1817,15 +1808,15 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { - "payer_id": "abc123", - "token": "xyz789" + "payer_id": "xyz789", + "token": "abc123" } ``` @@ -1839,15 +1830,15 @@ A set of relative URLs that PayPal uses in response to various actions during th | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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", + "cancel_url": "abc123", "error_url": "xyz789", "return_url": "abc123" } @@ -1883,9 +1874,9 @@ Contains information used to generate PayPal iframe for transaction. Applies to | 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. | +| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example @@ -1893,8 +1884,8 @@ Contains information used to generate PayPal iframe for transaction. Applies to { "mode": "TEST", "paypal_url": "abc123", - "secure_token": "abc123", - "secure_token_id": "xyz789" + "secure_token": "xyz789", + "secure_token_id": "abc123" } ``` @@ -1908,7 +1899,7 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -1926,8 +1917,8 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | 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. | +| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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 @@ -1948,8 +1939,8 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | #### Example @@ -1968,7 +1959,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -1986,7 +1977,7 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | | `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example @@ -2008,17 +1999,17 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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", + "cancel_url": "xyz789", "error_url": "abc123", - "return_url": "xyz789" + "return_url": "abc123" } ``` @@ -2032,21 +2023,21 @@ Contains payment fields that are common to all types of payment methods. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | -| [`ApplePayConfig`](#applepayconfig) | -| [`GooglePayConfig`](#googlepayconfig) | +| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | +| [`ApplePayConfig`](types-a-b.md#applepayconfig) | +| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | #### Example @@ -2057,7 +2048,7 @@ Contains payment fields that are common to all types of payment methods. "payment_intent": "abc123", "sdk_params": [SDKParams], "sort_order": "abc123", - "title": "abc123" + "title": "xyz789" } ``` @@ -2071,10 +2062,10 @@ Retrieves the payment configuration for a given location | 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 | +| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2119,27 +2110,27 @@ Defines the payment method. | 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. | +| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](types-f-i.md#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 | +| `payflowpro_cc_vault` - [`VaultTokenInput`](types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#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. | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -2153,7 +2144,7 @@ Defines the payment method. "braintree_googlepay_vault": BraintreeVaultInput, "braintree_paypal": BraintreeInput, "braintree_paypal_vault": BraintreeVaultInput, - "code": "abc123", + "code": "xyz789", "hosted_pro": HostedProInput, "payflow_express": PayflowExpressInput, "payflow_link": PayflowLinkInput, @@ -2165,7 +2156,7 @@ Defines the payment method. "payment_services_paypal_smart_buttons": SmartButtonMethodInput, "payment_services_paypal_vault": VaultMethodInput, "paypal_express": PaypalExpressInput, - "purchase_order_number": "xyz789" + "purchase_order_number": "abc123" } ``` @@ -2179,10 +2170,10 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#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 | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example @@ -2191,7 +2182,7 @@ Contains the payment order details "id": "abc123", "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } ``` @@ -2203,14 +2194,14 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | +| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | #### Example ```json { - "code": "xyz789", + "code": "abc123", "params": [SDKParams] } ``` @@ -2223,7 +2214,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | +| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2241,9 +2232,9 @@ The stored payment method available to the customer. | 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. | +| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example @@ -2251,7 +2242,7 @@ The stored payment method available to the customer. ```json { "details": "xyz789", - "payment_method_code": "abc123", + "payment_method_code": "xyz789", "public_hash": "xyz789", "type": "card" } @@ -2286,15 +2277,15 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { - "payer_id": "abc123", - "token": "abc123" + "payer_id": "xyz789", + "token": "xyz789" } ``` @@ -2308,21 +2299,21 @@ Defines the attributes required to receive a payment token for Express Checkout | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](types-a-b.md#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. | +| `use_paypal_credit` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { - "cart_id": "xyz789", - "code": "xyz789", - "express_button": false, + "cart_id": "abc123", + "code": "abc123", + "express_button": true, "urls": PaypalExpressUrlsInput, - "use_paypal_credit": false + "use_paypal_credit": true } ``` @@ -2337,14 +2328,14 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | 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. | +| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | #### Example ```json { "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" + "token": "abc123" } ``` @@ -2358,15 +2349,15 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | 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. | +| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | #### Example ```json { "edit": "abc123", - "start": "abc123" + "start": "xyz789" } ``` @@ -2380,18 +2371,18 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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", + "cancel_url": "xyz789", "pending_url": "xyz789", - "return_url": "xyz789", + "return_url": "abc123", "success_url": "xyz789" } ``` @@ -2406,22 +2397,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](types-f-i.md#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) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | #### Example ```json -{"weight": 987.65} +{"weight": 123.45} ``` @@ -2434,39 +2425,39 @@ Defines Pickup Location information. | 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) | | +| `city` - [`String`](types-q-s.md#string) | | +| `contact_name` - [`String`](types-q-s.md#string) | | +| `country_id` - [`String`](types-q-s.md#string) | | +| `description` - [`String`](types-q-s.md#string) | | +| `email` - [`String`](types-q-s.md#string) | | +| `fax` - [`String`](types-q-s.md#string) | | +| `latitude` - [`Float`](types-f-i.md#float) | | +| `longitude` - [`Float`](types-f-i.md#float) | | +| `name` - [`String`](types-q-s.md#string) | | +| `phone` - [`String`](types-q-s.md#string) | | +| `pickup_location_code` - [`String`](types-q-s.md#string) | | +| `postcode` - [`String`](types-q-s.md#string) | | +| `region` - [`String`](types-q-s.md#string) | | +| `region_id` - [`Int`](types-f-i.md#int) | | +| `street` - [`String`](types-q-s.md#string) | | #### Example ```json { "city": "xyz789", - "contact_name": "xyz789", + "contact_name": "abc123", "country_id": "abc123", "description": "abc123", "email": "abc123", - "fax": "xyz789", - "latitude": 123.45, + "fax": "abc123", + "latitude": 987.65, "longitude": 987.65, - "name": "abc123", + "name": "xyz789", "phone": "abc123", "pickup_location_code": "xyz789", "postcode": "xyz789", - "region": "xyz789", + "region": "abc123", "region_id": 123, "street": "xyz789" } @@ -2482,14 +2473,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | 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. | +| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2516,22 +2507,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | 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. | +| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2567,8 +2558,8 @@ Top level object returned in a pickup locations search. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | #### Example @@ -2590,12 +2581,12 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -2627,7 +2618,7 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -2668,12 +2659,12 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json -{"purchase_order_uid": "4"} +{"purchase_order_uid": 4} ``` @@ -2686,7 +2677,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | #### Example @@ -2704,7 +2695,7 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2724,7 +2715,7 @@ Contains the results of the request to place an order. |------------|-------------| | `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. | +| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | #### Example @@ -2746,7 +2737,7 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2867,15 +2858,15 @@ Can be used to retrieve the main price details in case of bundle product | 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 | +| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | #### Example ```json { - "discount_percentage": 987.65, + "discount_percentage": 123.45, "main_final_price": 987.65, "main_price": 987.65 } @@ -2952,15 +2943,15 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | +| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | #### Example ```json { "code": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -2974,15 +2965,15 @@ Defines the filters to be used in the search. A filter contains at least one att | 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 | +| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | +| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -3010,10 +3001,10 @@ Specifies the attribute to use for sorting search results and indicates whether | 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). | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -3031,8 +3022,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3053,13 +3044,13 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | #### Example ```json -{"amount_off": 123.45, "percent_off": 987.65} +{"amount_off": 123.45, "percent_off": 123.45} ``` @@ -3072,45 +3063,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | 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. | +| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](types-f-i.md#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. | +| `price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -3168,18 +3159,18 @@ Contains product image information, including the image URL and label. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { - "disabled": false, + "disabled": true, "label": "abc123", - "position": 123, + "position": 987, "url": "abc123" } ``` @@ -3194,12 +3185,12 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | +| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -3212,100 +3203,100 @@ Contains fields that are common to all types of products. | 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.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#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.)* | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#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.)* | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](types-q-s.md#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. | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#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. | +| `rating_summary` - [`Float!`](types-f-i.md#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. | +| `review_count` - [`Int!`](types-f-i.md#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. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#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. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#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. | +| `swatch_image` - [`String`](types-q-s.md#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_price` - [`Float`](types-f-i.md#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.)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#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.)* | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | #### Example ```json { - "attribute_set_id": 987, - "canonical_url": "abc123", + "attribute_set_id": 123, + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "xyz789", + "color": 123, + "country_of_manufacture": "abc123", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": "xyz789", - "id": 987, + "gift_message_available": "abc123", + "id": 123, "image": ProductImage, "is_returnable": "xyz789", "manufacturer": 123, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "xyz789", "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options_container": "xyz789", + "only_x_left_in_stock": 123.45, + "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -3317,23 +3308,23 @@ Contains fields that are common to all types of products. "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 123.45, - "special_to_date": "xyz789", + "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type_id": "xyz789", - "uid": "4", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website] } ``` @@ -3348,21 +3339,21 @@ An implementation of `ProductLinksInterface`. | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { "link_type": "xyz789", - "linked_product_sku": "abc123", + "linked_product_sku": "xyz789", "linked_product_type": "abc123", - "position": 987, - "sku": "abc123" + "position": 123, + "sku": "xyz789" } ``` @@ -3376,11 +3367,11 @@ Contains information about linked products, including the link type and product | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3392,10 +3383,10 @@ Contains information about linked products, including the link type and product ```json { - "link_type": "xyz789", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 987, + "link_type": "abc123", + "linked_product_sku": "abc123", + "linked_product_type": "abc123", + "position": 123, "sku": "xyz789" } ``` @@ -3410,15 +3401,15 @@ Contains an image in base64 format and basic information about the image. | 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. | +| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "base64_encoded_data": "abc123", + "base64_encoded_data": "xyz789", "name": "abc123", "type": "abc123" } @@ -3434,20 +3425,20 @@ Contains a link to a video file and basic information about the video. | 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. | +| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | #### Example ```json { - "media_type": "abc123", - "video_description": "xyz789", - "video_metadata": "abc123", + "media_type": "xyz789", + "video_description": "abc123", + "video_metadata": "xyz789", "video_provider": "abc123", "video_title": "xyz789", "video_url": "xyz789" @@ -3466,7 +3457,7 @@ Represents a product price. |------------|-------------| | `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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#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 @@ -3514,13 +3505,13 @@ Contains details of a product review. | 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. | +| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](types-q-s.md#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. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example @@ -3531,7 +3522,7 @@ Contains details of a product review. "nickname": "xyz789", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], - "summary": "abc123", + "summary": "xyz789", "text": "xyz789" } ``` @@ -3546,8 +3537,8 @@ Contains data about a single aspect of a product review. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example @@ -3568,8 +3559,8 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example @@ -3590,8 +3581,8 @@ Contains details about a single aspect of a product review. | 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. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](types-q-s.md#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 @@ -3614,14 +3605,14 @@ Contains details about a single value in a product review. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { - "value": "abc123", + "value": "xyz789", "value_id": "xyz789" } ``` @@ -3655,7 +3646,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -3695,20 +3686,20 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | 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.)* | +| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json { - "customer_group_id": "abc123", - "percentage_value": 987.65, + "customer_group_id": "xyz789", + "percentage_value": 123.45, "qty": 123.45, - "value": 987.65, + "value": 123.45, "website_id": 123.45 } ``` @@ -3723,10 +3714,10 @@ Contains information about a product video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example @@ -3751,13 +3742,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](types-a-b.md#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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -3769,7 +3760,7 @@ Contains the results of a `products` query. "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } ``` @@ -3786,15 +3777,15 @@ Contains details about a purchase order. | `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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](types-c-e.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -3806,12 +3797,12 @@ Contains details about a purchase order. "created_at": "abc123", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], - "number": "abc123", + "number": "xyz789", "order": CustomerOrder, "quote": Cart, "status": "PENDING", - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } ``` @@ -3845,13 +3836,13 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -3864,18 +3855,18 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | +| `message` - [`String`](types-q-s.md#string) | A formatted message. | +| `name` - [`String`](types-q-s.md#string) | The approver name. | +| `role` - [`String`](types-q-s.md#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. | +| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { "message": "xyz789", - "name": "xyz789", + "name": "abc123", "role": "abc123", "status": "PENDING", "updated_at": "xyz789" @@ -3910,16 +3901,16 @@ Contains details about a purchase order approval rule. | 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. | +| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -3929,11 +3920,11 @@ Contains details about a purchase order approval rule. "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "xyz789", - "created_by": "abc123", - "description": "abc123", - "name": "xyz789", + "created_by": "xyz789", + "description": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "xyz789" } ``` @@ -4019,12 +4010,12 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} ``` @@ -4037,11 +4028,11 @@ Defines a new purchase order approval rule. | 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. | +| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example @@ -4049,10 +4040,10 @@ Defines a new purchase order approval rule. ```json { "applies_to": ["4"], - "approvers": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "abc123", - "name": "xyz789", + "name": "abc123", "status": "ENABLED" } ``` @@ -4067,9 +4058,9 @@ Contains metadata that can be used to render rule edit forms. | 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. | +| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4127,8 +4118,8 @@ Contains the approval rules that the customer can see. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4136,7 +4127,7 @@ Contains the approval rules that the customer can see. { "items": [PurchaseOrderApprovalRule], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -4150,10 +4141,10 @@ Contains details about a comment. | 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. | +| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | #### Example @@ -4161,7 +4152,7 @@ Contains details about a comment. { "author": Customer, "created_at": "xyz789", - "text": "xyz789", + "text": "abc123", "uid": "4" } ``` @@ -4196,19 +4187,19 @@ Contains details about a status change. | 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. | +| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "activity": "abc123", + "activity": "xyz789", "created_at": "abc123", "message": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -4223,14 +4214,14 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | +| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | #### Example ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "abc123" + "rule_name": "xyz789" } ``` @@ -4269,8 +4260,8 @@ Contains a list of purchase orders. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4292,12 +4283,12 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | #### Example ```json -{"purchase_order_uids": ["4"]} +{"purchase_order_uids": [4]} ``` @@ -4332,18 +4323,18 @@ Defines the criteria to use to filter the list of purchase orders. | 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. | +| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](types-a-b.md#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, + "company_purchase_orders": true, "created_date": FilterRangeTypeInput, - "require_my_approval": true, + "require_my_approval": false, "status": "PENDING" } ``` 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 index a4fc93572..118ffc47f 100644 --- 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 @@ -27,17 +27,17 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `item_id` - [`ID!`](types-f-i.md#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. | +| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "item_id": 4, - "note": "xyz789", - "templateId": 4 + "item_id": "4", + "note": "abc123", + "templateId": "4" } ``` @@ -76,9 +76,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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 | +| `is_enabled` - [`Boolean!`](types-a-b.md#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. | +| `minimum_score` - [`Float!`](types-f-i.md#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 @@ -86,12 +86,12 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { "badge_position": "xyz789", - "failure_message": "abc123", + "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "xyz789", - "minimum_score": 123.45, - "website_key": "abc123" + "is_enabled": true, + "language_code": "abc123", + "minimum_score": 987.65, + "website_key": "xyz789" } ``` @@ -129,7 +129,7 @@ Contains reCAPTCHA V3-Invisible configuration details. | 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. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example @@ -137,7 +137,7 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { "code": "xyz789", - "id": 987, + "id": 123, "name": "xyz789" } ``` @@ -170,7 +170,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -196,7 +196,7 @@ Remove coupons from the cart. ```json { "cart_id": "xyz789", - "coupon_codes": ["xyz789"] + "coupon_codes": ["abc123"] } ``` @@ -217,8 +217,8 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "abc123", - "gift_card_code": "xyz789" + "cart_id": "xyz789", + "gift_card_code": "abc123" } ``` @@ -232,7 +232,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -250,7 +250,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -268,7 +268,7 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example @@ -286,7 +286,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -305,15 +305,15 @@ Specifies which items to remove from the cart. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { - "cart_id": "abc123", - "cart_item_id": 123, + "cart_id": "xyz789", + "cart_item_id": 987, "cart_item_uid": 4 } ``` @@ -328,7 +328,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -346,16 +346,13 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "quote_item_uids": ["4"], - "quote_uid": "4" -} +{"quote_item_uids": [4], "quote_uid": 4} ``` @@ -368,7 +365,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -386,16 +383,13 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{ - "item_uids": ["4"], - "template_id": "4" -} +{"item_uids": [4], "template_id": 4} ``` @@ -408,8 +402,8 @@ Defines which products to remove from a compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example @@ -430,8 +424,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -452,12 +446,12 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example ```json -{"return_shipping_tracking_uid": 4} +{"return_shipping_tracking_uid": "4"} ``` @@ -488,7 +482,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -524,7 +518,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -544,14 +538,14 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example ```json { "quote_comment": "abc123", - "quote_name": "abc123", + "quote_name": "xyz789", "quote_uid": "4" } ``` @@ -566,7 +560,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -584,8 +578,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -606,19 +600,19 @@ Defines properties of a negotiable quote request. | 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. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](types-a-b.md#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, + "cart_id": "4", "comment": NegotiableQuoteCommentInput, "is_draft": false, - "quote_name": "abc123" + "quote_name": "xyz789" } ``` @@ -632,7 +626,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -650,7 +644,7 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example @@ -671,13 +665,13 @@ Contains information needed to start a return request. | `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. | +| `order_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { - "comment_text": "xyz789", + "comment_text": "abc123", "contact_email": "xyz789", "items": [RequestReturnItemInput], "order_uid": "4" @@ -694,9 +688,9 @@ Contains details about an item to be returned. | 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. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](types-f-i.md#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 @@ -707,7 +701,7 @@ Contains details about an item to be returned. EnteredCustomAttributeInput ], "order_item_uid": "4", - "quantity_to_return": 987.65, + "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -748,20 +742,20 @@ Defines the contents of a requisition list. |------------|-------------| | `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. | +| `items_count` - [`Int!`](types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "items": RequistionListItems, "items_count": 987, "name": "abc123", - "uid": 4, + "uid": "4", "updated_at": "abc123" } ``` @@ -776,8 +770,8 @@ Defines requisition list filters. | 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. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -799,20 +793,20 @@ The interface for requisition list items. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#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) | +| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -820,8 +814,8 @@ The interface for requisition list items. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -835,9 +829,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#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. | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -848,7 +842,7 @@ Defines the items to add. "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", "quantity": 123.45, - "selected_options": ["xyz789"], + "selected_options": ["abc123"], "sku": "xyz789" } ``` @@ -865,7 +859,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -873,7 +867,7 @@ Defines customer requisition lists. { "items": [RequisitionList], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -889,7 +883,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `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. | +| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | #### Example @@ -917,10 +911,10 @@ Contains details about a return. | `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. | +| `order` - [`CustomerOrder`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -928,10 +922,10 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "abc123", + "created_at": "xyz789", "customer": ReturnCustomer, "items": [ReturnItem], - "number": "xyz789", + "number": "abc123", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", @@ -952,15 +946,15 @@ Contains details about a return comment. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example ```json { - "author_name": "abc123", - "created_at": "xyz789", - "text": "xyz789", + "author_name": "xyz789", + "created_at": "abc123", + "text": "abc123", "uid": "4" } ``` @@ -976,7 +970,7 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example @@ -985,7 +979,7 @@ Contains details about a `ReturnCustomerAttribute` object. { "label": "xyz789", "uid": 4, - "value": "abc123" + "value": "xyz789" } ``` @@ -1007,9 +1001,9 @@ The customer information for the return. ```json { - "email": "abc123", - "firstname": "xyz789", - "lastname": "abc123" + "email": "xyz789", + "firstname": "abc123", + "lastname": "xyz789" } ``` @@ -1024,12 +1018,12 @@ Contains details about a product being returned. | 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. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1055,31 +1049,31 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](types-f-i.md#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. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#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. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#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. | +| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { - "code": 4, + "code": "4", "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": false, + "is_required": true, "is_unique": true, "label": "abc123", "multiline_count": 987, @@ -1144,7 +1138,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `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. | +| `country` - [`Country!`](types-c-e.md#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. | @@ -1154,13 +1148,13 @@ Contains details about the shipping address used for receiving returned items. ```json { - "city": "abc123", - "contact_name": "xyz789", + "city": "xyz789", + "contact_name": "abc123", "country": Country, "postcode": "abc123", "region": Region, "street": ["xyz789"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1175,13 +1169,13 @@ Contains details about the carrier on a return. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "uid": "4" } ``` @@ -1199,7 +1193,7 @@ Contains shipping and tracking details. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1208,7 +1202,7 @@ Contains shipping and tracking details. "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, "tracking_number": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -1228,7 +1222,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "abc123", "type": "INFORMATION"} +{"text": "xyz789", "type": "INFORMATION"} ``` @@ -1287,7 +1281,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | #### Example @@ -1295,7 +1289,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1309,12 +1303,12 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example ```json -{"result": false} +{"result": true} ``` @@ -1351,13 +1345,13 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | #### Example ```json -{"money": Money, "points": 123.45} +{"money": Money, "points": 987.65} ``` @@ -1373,14 +1367,14 @@ Contain details about the reward points transaction. | `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. | +| `points_change` - [`Float!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example ```json { "balance": RewardPointsAmount, - "change_reason": "xyz789", + "change_reason": "abc123", "date": "xyz789", "points_change": 987.65 } @@ -1418,8 +1412,8 @@ Contains details about customer's reward points rate. | 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. | +| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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 @@ -1476,23 +1470,23 @@ Routable entities serve as the model for a rendered page. | 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. | +| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | +| [`CmsPage`](types-c-e.md#cmspage) | +| [`CategoryTree`](types-c-e.md#categorytree) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | | [`RoutableUrl`](#routableurl) | #### Example @@ -1515,16 +1509,16 @@ Default implementation of RoutableInterface. This type is returned when the URL | 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. | +| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { "redirect_code": 987, - "relative_url": "xyz789", + "relative_url": "abc123", "type": "CMS_PAGE" } ``` @@ -1546,7 +1540,7 @@ Defines the name and value of a SDK parameter ```json { - "name": "xyz789", + "name": "abc123", "value": "xyz789" } ``` @@ -1569,7 +1563,7 @@ Contains details about a comment. ```json { "message": "abc123", - "timestamp": "abc123" + "timestamp": "xyz789" } ``` @@ -1603,14 +1597,14 @@ Provides navigation for the query response. | 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. | +| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 123, "page_size": 987, "total_pages": 123} +{"current_page": 123, "page_size": 123, "total_pages": 123} ``` @@ -1628,7 +1622,7 @@ A string that contains search suggestion #### Example ```json -{"search": "abc123"} +{"search": "xyz789"} ``` @@ -1641,10 +1635,10 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](types-f-i.md#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 | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example @@ -1653,7 +1647,7 @@ Contains details about a selected bundle option. { "id": 123, "label": "xyz789", - "type": "xyz789", + "type": "abc123", "uid": 4, "values": [SelectedBundleOptionValue] } @@ -1669,20 +1663,20 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | +| `id` - [`Int!`](types-f-i.md#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 | +| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { "id": 123, - "label": "xyz789", - "price": 123.45, - "quantity": 123.45, + "label": "abc123", + "price": 987.65, + "quantity": 987.65, "uid": "4" } ``` @@ -1697,11 +1691,11 @@ Contains details about a selected configurable option. | 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.)* | +| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](types-f-i.md#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_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | | `value_label` - [`String!`](#string) | The display name of the selected configurable option. | #### Example @@ -1709,10 +1703,10 @@ Contains details about a selected configurable option. ```json { "configurable_product_option_uid": "4", - "configurable_product_option_value_uid": "4", - "id": 123, + "configurable_product_option_value_uid": 4, + "id": 987, "option_label": "xyz789", - "value_id": 987, + "value_id": 123, "value_label": "abc123" } ``` @@ -1728,12 +1722,15 @@ Contains details about an attribute the buyer selected. | 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. | +| `value` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | #### Example ```json -{"attribute_code": "xyz789", "value": 4} +{ + "attribute_code": "abc123", + "value": "4" +} ``` @@ -1746,11 +1743,11 @@ Identifies a customized product that has been placed in a cart. | 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. | +| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](types-a-b.md#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. | +| `sort_order` - [`Int!`](types-f-i.md#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. | @@ -1759,11 +1756,11 @@ Identifies a customized product that has been placed in a cart. ```json { "customizable_option_uid": 4, - "id": 987, - "is_required": false, - "label": "abc123", - "sort_order": 123, - "type": "abc123", + "id": 123, + "is_required": true, + "label": "xyz789", + "sort_order": 987, + "type": "xyz789", "values": [SelectedCustomizableOptionValue] } ``` @@ -1778,17 +1775,17 @@ Identifies the value of the selected customized option. | 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.)* | +| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](types-f-i.md#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. | +| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | | `value` - [`String!`](#string) | The text identifying the selected value. | #### Example ```json { - "customizable_option_value_uid": "4", + "customizable_option_value_uid": 4, "id": 987, "label": "abc123", "price": CartItemSelectedOptionValuePrice, @@ -1814,9 +1811,9 @@ Describes the payment method the shopper selected. ```json { - "code": "abc123", + "code": "xyz789", "purchase_order_number": "xyz789", - "title": "abc123" + "title": "xyz789" } ``` @@ -1830,14 +1827,14 @@ Contains details about the selected shipping method and carrier. | 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.)* | +| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](types-k-p.md#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. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1864,7 +1861,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](types-f-i.md#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. | @@ -1872,7 +1869,7 @@ Defines the referenced product and the email sender and recipients. ```json { - "product_id": 987, + "product_id": 123, "recipients": [SendEmailToFriendRecipientInput], "sender": SendEmailToFriendSenderInput } @@ -1939,7 +1936,7 @@ Contains details about a recipient. ```json { - "email": "xyz789", + "email": "abc123", "name": "xyz789" } ``` @@ -1964,7 +1961,7 @@ An output object that contains information about the sender. { "email": "abc123", "message": "abc123", - "name": "xyz789" + "name": "abc123" } ``` @@ -1986,7 +1983,7 @@ Contains details about the sender. ```json { - "email": "abc123", + "email": "xyz789", "message": "abc123", "name": "abc123" } @@ -2002,13 +1999,13 @@ Contains details about the configuration of the Email to a Friend feature. | 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. | +| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": true, "enabled_for_guests": false} +{"enabled_for_customers": true, "enabled_for_guests": true} ``` @@ -2021,16 +2018,13 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "comment": NegotiableQuoteCommentInput, - "quote_uid": "4" -} +{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} ``` @@ -2043,7 +2037,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2061,7 +2055,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2069,7 +2063,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "abc123" + "cart_id": "xyz789" } ``` @@ -2083,7 +2077,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2102,18 +2096,18 @@ Defines the gift options applied to the cart. | 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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "gift_message": GiftMessageInput, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping_id": 4, "printed_card_included": false } @@ -2129,7 +2123,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | #### Example @@ -2169,7 +2163,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2187,7 +2181,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2205,15 +2199,15 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -2227,7 +2221,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2245,15 +2239,15 @@ Defines the payment method of the specified negotiable quote. | 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. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2267,7 +2261,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2285,15 +2279,15 @@ Defines the shipping address to assign to the negotiable quote. | 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. | +| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "customer_address_id": "4", + "customer_address_id": 4, "quote_uid": "4", "shipping_addresses": [ NegotiableQuoteShippingAddressInput @@ -2311,7 +2305,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2329,7 +2323,7 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | | `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | #### Example @@ -2351,7 +2345,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2369,8 +2363,8 @@ Defines the shipping address to assign to the negotiable quote template. | 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. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2392,7 +2386,7 @@ Applies a payment method to the quote. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2414,13 +2408,13 @@ Applies a payment method to the cart. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "payment_method": PaymentMethodInput } ``` @@ -2435,7 +2429,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2460,7 +2454,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2475,7 +2469,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2500,7 +2494,7 @@ Applies one or shipping methods to the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "shipping_methods": [ShippingMethodInput] } ``` @@ -2515,7 +2509,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2541,7 +2535,7 @@ Defines a gift registry invitee. ```json { "email": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -2555,12 +2549,12 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example ```json -{"is_shared": false} +{"is_shared": true} ``` @@ -2581,7 +2575,7 @@ Defines the sender of an invitation to view a gift registry. ```json { "message": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -2612,12 +2606,12 @@ Defines whether bundle items must be shipped together. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example @@ -2627,8 +2621,8 @@ Defines whether bundle items must be shipped together. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "product_sku": "abc123", + "quantity_shipped": 123.45 } ``` @@ -2642,19 +2636,19 @@ Order shipment item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example @@ -2663,7 +2657,7 @@ Order shipment item details. { "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_shipped": 987.65 @@ -2689,8 +2683,8 @@ Contains order shipment tracking details. ```json { "carrier": "abc123", - "number": "abc123", - "title": "abc123" + "number": "xyz789", + "title": "xyz789" } ``` @@ -2704,8 +2698,8 @@ Defines a single shipping address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](types-f-i.md#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. | @@ -2715,7 +2709,7 @@ Defines a single shipping address. { "address": CartAddressInput, "customer_address_id": 123, - "customer_notes": "xyz789", + "customer_notes": "abc123", "pickup_location_code": "xyz789" } ``` @@ -2730,23 +2724,23 @@ Contains shipping addresses and methods. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#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. | +| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#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.)* | +| `items_weight` - [`Float`](types-f-i.md#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. | +| `region` - [`CartAddressRegion`](types-c-e.md#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. | @@ -2761,26 +2755,26 @@ Contains shipping addresses and methods. "available_shipping_methods": [AvailableShippingMethod], "cart_items": [CartItemQuantity], "cart_items_v2": [CartItemInterface], - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_notes": "xyz789", + "customer_notes": "abc123", "fax": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "items_weight": 123.45, "lastname": "xyz789", "middlename": "xyz789", "pickup_location_code": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CartAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "xyz789", - "telephone": "abc123", + "telephone": "xyz789", "uid": "abc123", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -2794,7 +2788,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | #### Example @@ -2812,11 +2806,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](types-k-p.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | #### Example @@ -2848,7 +2842,7 @@ Defines the shipping carrier and method. ```json { "carrier_code": "xyz789", - "method_code": "abc123" + "method_code": "xyz789" } ``` @@ -2862,22 +2856,22 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#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. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#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. | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2889,10 +2883,10 @@ An implementation for simple product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", - "is_available": true, + "id": "abc123", + "is_available": false, "max_qty": 987.65, - "min_qty": 123.45, + "min_qty": 987.65, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -2912,125 +2906,125 @@ Defines a simple product, which is tangible and is usually sold in single units | 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.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#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.)* | +| `categories` - [`[CategoryInterface]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#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. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#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. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#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.)* | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#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. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#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. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#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. | +| `small_image` - [`ProductImage`](types-k-p.md#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_price` - [`Float`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#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. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#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. | +| `uid` - [`ID!`](types-f-i.md#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. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#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_rewrites` - [`[UrlRewrite]`](types-t-z.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { "attribute_set_id": 987, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "abc123", + "color": 123, + "country_of_manufacture": "xyz789", "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": "xyz789", - "id": 123, + "id": 987, "image": ProductImage, - "is_returnable": "abc123", + "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": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "meta_title": "abc123", + "name": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", + "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, + "rating_summary": 987.65, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 123.45, "special_to_date": "xyz789", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", - "uid": "4", - "updated_at": "abc123", + "uid": 4, + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website], "weight": 987.65 } @@ -3046,8 +3040,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -3069,9 +3063,9 @@ Contains details about simple products added to a requisition list. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3080,7 +3074,7 @@ Contains details about simple products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -3097,20 +3091,20 @@ Contains a simple 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. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -3146,12 +3140,12 @@ Smart button payment inputs | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `button_styles` - [`ButtonStyles`](types-a-b.md#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 | +| `display_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](types-k-p.md#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 | @@ -3162,15 +3156,15 @@ Smart button payment inputs ```json { "button_styles": ButtonStyles, - "code": "xyz789", - "display_message": true, + "code": "abc123", + "display_message": false, "display_venmo": false, - "is_visible": true, + "is_visible": false, "message_styles": MessageStyles, "payment_intent": "abc123", "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "xyz789" + "sort_order": "abc123", + "title": "abc123" } ``` @@ -3211,7 +3205,7 @@ Defines a possible sort field. ```json { "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -3305,27 +3299,27 @@ Contains information about a store's configuration. | `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. | +| `autocomplete_on_storefront` - [`Boolean`](types-a-b.md#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_allowspecific` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](types-a-b.md#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_3dsecure_verify_3dsecure` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](types-a-b.md#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_applepay_vault_active` - [`Boolean`](types-a-b.md#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_cc_vault_cvv` - [`Boolean`](types-a-b.md#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_googlepay_vault_active` - [`Boolean`](types-a-b.md#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. | @@ -3333,116 +3327,116 @@ Contains information about a store's configuration. | `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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_cart_type_paypal_show` - [`Boolean`](types-a-b.md#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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_checkout_type_paypal_show` - [`Boolean`](types-a-b.md#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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_button_location_productpage_type_paypal_show` - [`Boolean`](types-a-b.md#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_display_on_shopping_cart` - [`Boolean`](types-a-b.md#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 | +| `braintree_paypal_require_billing_address` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](types-f-i.md#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 | +| `cart_summary_display_quantity` - [`Int`](types-f-i.md#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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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. | +| `contact_enabled` - [`Boolean!`](types-a-b.md#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. | +| `create_account_confirmation` - [`Boolean`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](types-f-i.md#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 | +| `demonotice` - [`Int`](types-f-i.md#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`](types-a-b.md#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` - [`Int`](types-f-i.md#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 | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - checkout/options/guest_checkout | +| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#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` - [`Int`](types-f-i.md#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. | +| `logo_height` - [`Int`](types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](types-f-i.md#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. | @@ -3457,27 +3451,27 @@ Contains information about a store's configuration. | `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 | +| `max_items_in_order_summary` - [`Int`](types-f-i.md#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 | +| `minicart_display` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - checkout/sidebar/display | +| `minicart_max_items` - [`Int`](types-f-i.md#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. | +| `newsletter_enabled` - [`Boolean!`](types-a-b.md#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. | +| `order_cancellation_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `quickorder_active` - [`Boolean!`](types-a-b.md#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. | +| `root_category_id` - [`Int`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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`. | @@ -3485,35 +3479,35 @@ Contains information about a store's configuration. | `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. | +| `shopping_cart_display_full_summary` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#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. | +| `store_sort_order` - [`Int`](types-f-i.md#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.)* | +| `use_store_in_url` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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 @@ -3526,125 +3520,125 @@ Contains information about a store's configuration. "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", + "allow_order": "xyz789", + "allow_printed_card": "abc123", + "autocomplete_on_storefront": false, + "base_currency_code": "abc123", + "base_link_url": "xyz789", + "base_media_url": "xyz789", "base_static_url": "abc123", - "base_url": "abc123", + "base_url": "xyz789", "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_3dsecure_verify_3dsecure": true, + "braintree_ach_direct_debit_vault_active": true, "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_applepay_vault_active": true, + "braintree_cc_vault_active": "abc123", + "braintree_cc_vault_cvv": false, + "braintree_environment": "xyz789", + "braintree_googlepay_btn_color": "abc123", + "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_merchant_id": "xyz789", "braintree_googlepay_vault_active": false, - "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": "abc123", - "braintree_paypal_button_location_cart_type_credit_color": "xyz789", - "braintree_paypal_button_location_cart_type_credit_label": "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_credit_show": true, "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123", - "braintree_paypal_button_location_cart_type_messaging_show": false, - "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123", + "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", + "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_cart_type_messaging_show": true, + "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789", "braintree_paypal_button_location_cart_type_paylater_color": "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_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_label": "abc123", "braintree_paypal_button_location_cart_type_paypal_shape": "abc123", - "braintree_paypal_button_location_cart_type_paypal_show": false, + "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_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_credit_show": true, "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_logo": "xyz789", + "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": "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_paypal_color": "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": "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": false, + "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": "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_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": "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_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": "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_shape": "abc123", "braintree_paypal_button_location_productpage_type_paypal_show": false, - "braintree_paypal_credit_uk_merchant_name": "abc123", + "braintree_paypal_credit_uk_merchant_name": "xyz789", "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", + "braintree_paypal_require_billing_address": false, + "braintree_paypal_send_cart_line_items": false, + "braintree_paypal_vault_active": true, + "cart_expires_in_days": 123, + "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": "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", + "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": "abc123", - "check_money_order_new_order_status": "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_send_check_to": "xyz789", "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", - "cms_home_page": "xyz789", + "cms_home_page": "abc123", "cms_no_cookies": "xyz789", "cms_no_route": "xyz789", "code": "abc123", - "configurable_thumbnail_source": "abc123", + "configurable_thumbnail_source": "xyz789", "contact_enabled": false, "copyright": "xyz789", - "countries_with_required_region": "xyz789", + "countries_with_required_region": "abc123", "create_account_confirmation": false, "customer_access_token_lifetime": 987.65, - "default_country": "xyz789", - "default_description": "abc123", + "default_country": "abc123", + "default_description": "xyz789", "default_display_currency_code": "xyz789", - "default_keywords": "xyz789", - "default_title": "abc123", - "demonotice": 987, - "display_state_if_optional": true, + "default_keywords": "abc123", + "default_title": "xyz789", + "demonotice": 123, + "display_state_if_optional": false, "enable_multiple_wishlists": "xyz789", "front": "abc123", "grid_per_page": 987, @@ -3652,9 +3646,9 @@ Contains information about a store's configuration. "head_includes": "abc123", "head_shortcut_icon": "abc123", "header_logo_src": "xyz789", - "id": 987, + "id": 123, "is_default_store": true, - "is_default_store_group": false, + "is_default_store_group": true, "is_guest_checkout_enabled": false, "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, @@ -3662,82 +3656,82 @@ Contains information about a store's configuration. "list_mode": "xyz789", "list_per_page": 123, "list_per_page_values": "abc123", - "locale": "abc123", - "logo_alt": "xyz789", - "logo_height": 123, + "locale": "xyz789", + "logo_alt": "abc123", + "logo_height": 987, "logo_width": 987, "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": "abc123", - "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "abc123", - "magento_reward_points_invitation_order_limit": "xyz789", + "magento_reward_points_invitation_order_limit": "abc123", "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "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": "abc123", - "max_items_in_order_summary": 987, - "maximum_number_of_wishlists": "xyz789", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "abc123", "minicart_display": true, - "minicart_max_items": 123, - "minimum_password_length": "xyz789", + "minicart_max_items": 987, + "minimum_password_length": "abc123", "newsletter_enabled": true, - "no_route": "abc123", + "no_route": "xyz789", "optional_zip_countries": "xyz789", - "order_cancellation_enabled": true, + "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], - "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "abc123", + "payment_payflowpro_cc_vault_active": "abc123", + "printed_card_price": "xyz789", "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", "quickorder_active": true, "required_character_classes_number": "xyz789", - "returns_enabled": "abc123", - "root_category_id": 123, + "returns_enabled": "xyz789", + "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": "abc123", + "secure_base_link_url": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_url": "abc123", "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_shipping": 123, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 123, "store_code": 4, "store_group_code": "4", - "store_group_name": "xyz789", + "store_group_name": "abc123", "store_name": "xyz789", - "store_sort_order": 987, - "timezone": "xyz789", - "title_prefix": "xyz789", + "store_sort_order": 123, + "timezone": "abc123", + "title_prefix": "abc123", "title_separator": "abc123", - "title_suffix": "xyz789", + "title_suffix": "abc123", "use_store_in_url": true, - "website_code": 4, - "website_id": 123, + "website_code": "4", + "website_id": 987, "website_name": "abc123", "weight_unit": "abc123", - "welcome": "abc123", + "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": false, + "zero_subtotal_enabled": true, "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "abc123", - "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "xyz789" + "zero_subtotal_title": "abc123" } ``` @@ -3751,11 +3745,11 @@ Indicates where an attribute can be displayed. | 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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example @@ -3763,8 +3757,8 @@ Indicates where an attribute can be displayed. { "position": 987, "use_in_layered_navigation": "NO", - "use_in_product_listing": false, - "use_in_search_results_layered_navigation": false, + "use_in_product_listing": true, + "use_in_search_results_layered_navigation": true, "visible_on_catalog_pages": true } ``` @@ -3794,18 +3788,18 @@ Specifies the quote template properties to update. | 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 | +| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](types-f-i.md#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. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "comment": "xyz789", - "max_order_commitment": 987, - "min_order_commitment": 123, + "max_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "template_id": "4" } @@ -3867,7 +3861,7 @@ Describes the swatch type and a value. ```json { - "type": "xyz789", + "type": "abc123", "value": "xyz789" } ``` @@ -3886,9 +3880,9 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | +| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | #### Example @@ -3939,7 +3933,7 @@ Swatch attribute metadata input types. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](types-f-i.md#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.)* | @@ -3995,7 +3989,7 @@ Synchronizes the payment order details ```json { "cartId": "xyz789", - "id": "abc123" + "id": "xyz789" } ``` 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 index 097fb9bfe..62643eb64 100644 --- 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 @@ -8,9 +8,9 @@ Contains tax item details. | 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. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | #### Example @@ -48,7 +48,7 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -66,9 +66,9 @@ Defines a price based on the quantity purchased. | 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. | +| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -76,7 +76,7 @@ Defines a price based on the quantity purchased. { "discount": ProductDiscount, "final_price": Money, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -90,8 +90,8 @@ Modifies the specified items in the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example @@ -112,7 +112,7 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | #### Example @@ -130,7 +130,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -148,7 +148,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -166,7 +166,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -184,7 +184,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -202,7 +202,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | +| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | #### Example @@ -220,12 +220,12 @@ Defines updates to a `GiftRegistry` object. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -235,7 +235,7 @@ Defines updates to a `GiftRegistry` object. GiftRegistryDynamicAttributeInput ], "event_name": "xyz789", - "message": "abc123", + "message": "xyz789", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, "status": "ACTIVE" @@ -252,9 +252,9 @@ Defines updates to an item in a gift registry. | 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. | +| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example @@ -262,7 +262,7 @@ Defines updates to an item in a gift registry. { "gift_registry_item_uid": "4", "note": "xyz789", - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -276,7 +276,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -294,7 +294,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -312,11 +312,11 @@ Defines updates to an existing registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -325,9 +325,9 @@ Defines updates to an existing registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", + "email": "abc123", "firstname": "abc123", - "gift_registry_registrant_uid": 4, + "gift_registry_registrant_uid": "4", "lastname": "abc123" } ``` @@ -342,7 +342,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -360,7 +360,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -378,15 +378,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -400,7 +400,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -418,15 +418,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": "4" + "template_id": 4 } ``` @@ -462,13 +462,13 @@ Defines the changes to be made to an approval rule. | 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. | +| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example @@ -478,7 +478,7 @@ Defines the changes to be made to an approval rule. "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "abc123", - "name": "abc123", + "name": "xyz789", "status": "ENABLED", "uid": 4 } @@ -494,14 +494,14 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | +| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "name": "xyz789" } ``` @@ -516,10 +516,10 @@ Defines which items in a requisition list to update. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | #### Example @@ -542,7 +542,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -560,7 +560,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -578,8 +578,8 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -587,7 +587,7 @@ Contains the name and visibility of an updated wish list. ```json { "name": "abc123", - "uid": 4, + "uid": "4", "visibility": "PUBLIC" } ``` @@ -602,8 +602,8 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](types-q-s.md#string) | The request URL. | #### Example @@ -664,15 +664,15 @@ Defines the input for returning matching companies the customer is assigned to. | 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. | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example ```json { - "currentPage": 987, + "currentPage": 123, "pageSize": 123, "sort": [CompaniesSortInput] } @@ -688,8 +688,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -710,7 +710,7 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example @@ -749,12 +749,12 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -768,7 +768,7 @@ Contains the results of validation attempts. | 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. | +| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -790,7 +790,7 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](#string) | Validation rule value. | +| `value` - [`String`](types-q-s.md#string) | Validation rule value. | #### Example @@ -837,18 +837,18 @@ Vault payment inputs | 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. | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | #### Example ```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" } ``` @@ -863,12 +863,12 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | #### Example ```json -{"public_hash": "abc123"} +{"public_hash": "xyz789"} ``` @@ -881,19 +881,19 @@ An implementation for virtual product cart items. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -903,15 +903,15 @@ An implementation for virtual product cart items. "discount": [Discount], "errors": [CartItemError], "id": "xyz789", - "is_available": true, - "max_qty": 123.45, + "is_available": false, + "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" + "uid": 4 } ``` @@ -925,62 +925,62 @@ Defines a virtual product, which is a non-tangible product that does not require | 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 | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#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.)* | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#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)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#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 | +| `url_suffix` - [`String`](types-q-s.md#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 @@ -988,36 +988,36 @@ Defines a virtual product, which is a non-tangible product that does not require ```json { "attribute_set_id": 123, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 123, + "color": 987, "country_of_manufacture": "abc123", "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": "xyz789", - "id": 987, + "id": 123, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "manufacturer": 987, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", "meta_title": "xyz789", - "name": "xyz789", + "name": "abc123", "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "xyz789", "review_count": 123, @@ -1026,23 +1026,23 @@ Defines a virtual product, which is a non-tangible product that does not require "sku": "xyz789", "small_image": ProductImage, "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "xyz789", + "special_price": 123.45, + "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", + "type_id": "xyz789", "uid": 4, - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -1057,8 +1057,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -1079,10 +1079,10 @@ Contains details about virtual products added to a requisition list. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1090,8 +1090,8 @@ Contains details about virtual products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -1105,12 +1105,12 @@ Contains a virtual product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -1121,7 +1121,7 @@ Contains a virtual product wish list item. "description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1135,23 +1135,23 @@ Deprecated. It should not be used on the storefront. Contains information about | 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.)* | +| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](types-q-s.md#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`](types-f-i.md#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", + "default_group_id": "abc123", "id": 987, "is_default": true, - "name": "xyz789", - "sort_order": 987 + "name": "abc123", + "sort_order": 123 } ``` @@ -1166,14 +1166,14 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -1206,20 +1206,20 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](types-f-i.md#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_count` - [`Int`](types-f-i.md#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. | +| `name` - [`String`](types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](types-q-s.md#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", + "id": 4, "items": [WishlistItem], "items_count": 123, "items_v2": WishlistItems, @@ -1241,9 +1241,9 @@ Contains details about errors encountered when a customer added wish list items | 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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example @@ -1287,19 +1287,19 @@ Contains details about a wish list item. | 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 | +| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "description": "xyz789", - "id": 123, + "id": 987, "product": ProductInterface, "qty": 123.45 } @@ -1315,13 +1315,16 @@ Specifies the IDs of items to copy and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json -{"quantity": 123.45, "wishlist_item_id": 4} +{ + "quantity": 123.45, + "wishlist_item_id": "4" +} ``` @@ -1334,21 +1337,21 @@ Defines the items to add to a wish list. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](types-q-s.md#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, + "parent_sku": "xyz789", + "quantity": 123.45, "selected_options": ["4"], - "sku": "xyz789" + "sku": "abc123" } ``` @@ -1362,24 +1365,24 @@ The interface for wish list items. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | +| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | +| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | +| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | #### Example @@ -1390,7 +1393,7 @@ The interface for wish list items. "description": "abc123", "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1404,14 +1407,14 @@ Specifies the IDs of the items to move and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json { - "quantity": 987.65, + "quantity": 123.45, "wishlist_item_id": "4" } ``` @@ -1426,21 +1429,21 @@ Defines updates to items in a wish list. | 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. | +| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "entered_options": [EnteredOptionInput], "quantity": 123.45, - "selected_options": [4], - "wishlist_item_id": "4" + "selected_options": ["4"], + "wishlist_item_id": 4 } ``` @@ -1455,7 +1458,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1477,17 +1480,17 @@ Deprecated: Use the `Wishlist` type instead. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](types-q-s.md#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, + "items_count": 123, "name": "xyz789", "sharing_code": "xyz789", "updated_at": "xyz789" 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 65eea2da2..ec90b769d 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 @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": true}}} +{"data": {"acceptCompanyInvitation": {"success": false}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -108,14 +108,14 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "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", + "min_order_commitment": 987, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -124,8 +124,8 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", + "status": "abc123", + "template_id": 4, "total_quantity": 123.45 } } @@ -138,13 +138,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -178,13 +178,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -222,13 +222,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -266,14 +266,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -322,14 +322,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -358,7 +358,7 @@ mutation addProductsToCart( ```json { - "cartId": "xyz789", + "cartId": "abc123", "cartItems": [CartItemInput] } ``` @@ -382,13 +382,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -422,7 +422,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": 4 } @@ -436,14 +436,14 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -492,14 +492,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -527,7 +527,10 @@ mutation addProductsToWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} +{ + "wishlistId": "4", + "wishlistItems": [WishlistItemInput] +} ``` ##### Response @@ -549,13 +552,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -595,13 +598,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -645,14 +648,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -681,7 +684,10 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{"requisitionListUid": 4, "requisitionListItemUids": [4]} +{ + "requisitionListUid": "4", + "requisitionListItemUids": [4] +} ``` ##### Response @@ -694,7 +700,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } } } @@ -706,13 +712,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -746,13 +752,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -796,13 +802,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -836,13 +842,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -876,14 +882,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -912,7 +918,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": [4]} +{"wishlistId": "4", "wishlistItemIds": [4]} ``` ##### Response @@ -924,7 +930,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } } @@ -937,13 +943,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -977,13 +983,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1017,13 +1023,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -1057,13 +1063,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -1082,7 +1088,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -1097,13 +1103,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1137,13 +1143,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1187,13 +1193,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1223,7 +1229,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": true + "result": false } } } @@ -1235,13 +1241,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | | +| `cart_id` - [`String!`](types-q-s.md#string) | | #### Example @@ -1311,7 +1317,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` ##### Response @@ -1332,14 +1338,14 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "billing_address": BillingCartAddress, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -1355,13 +1361,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1424,10 +1430,10 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "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": 123, + "max_order_commitment": 987, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -1437,9 +1443,9 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, - "total_quantity": 123.45 + "status": "xyz789", + "template_id": "4", + "total_quantity": 987.65 } } } @@ -1451,13 +1457,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | #### Example @@ -1489,7 +1495,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1503,13 +1509,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1553,14 +1559,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | #### Example @@ -1684,8 +1690,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "abc123", - "newPassword": "abc123" + "currentPassword": "xyz789", + "newPassword": "xyz789" } ``` @@ -1703,20 +1709,20 @@ mutation changeCustomerPassword( "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "xyz789", "default_shipping": "abc123", - "dob": "abc123", - "email": "abc123", - "firstname": "xyz789", + "dob": "xyz789", + "email": "xyz789", + "firstname": "abc123", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroup, "group_id": 123, - "id": 123, - "is_subscribed": false, - "job_title": "abc123", + "id": 987, + "is_subscribed": true, + "job_title": "xyz789", "lastname": "xyz789", "middlename": "xyz789", "orders": CustomerOrders, @@ -1726,7 +1732,7 @@ mutation changeCustomerPassword( "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, @@ -1755,13 +1761,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCartOutput!`](#clearcartoutput) +**Response:** [`ClearCartOutput!`](types-c-e.md#clearcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ClearCartInput!`](#clearcartinput) | An input object that defines cart ID of the shopper. | +| `input` - [`ClearCartInput!`](types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | #### Example @@ -1805,13 +1811,13 @@ mutation clearCart($input: ClearCartInput!) { Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1850,13 +1856,13 @@ mutation clearCustomerCart($cartUid: String!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1913,13 +1919,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Cancel the specified guest customer order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmCancelOrderInput!`](#confirmcancelorderinput) | | +| `input` - [`ConfirmCancelOrderInput!`](types-c-e.md#confirmcancelorderinput) | | #### Example @@ -1951,7 +1957,7 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { { "data": { "confirmCancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1965,13 +1971,13 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -2005,13 +2011,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Confirm the return. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmReturnInput!`](#confirmreturninput) | | +| `input` - [`ConfirmReturnInput!`](types-c-e.md#confirmreturninput) | | #### Example @@ -2055,13 +2061,13 @@ mutation confirmReturn($input: ConfirmReturnInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](#contactusoutput) +**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -2084,7 +2090,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": true}}} +{"data": {"contactUs": {"status": false}}} ``` @@ -2093,15 +2099,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2129,8 +2135,8 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": "4", + "sourceRequisitionListUid": "4", + "destinationRequisitionListUid": 4, "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2153,15 +2159,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2195,8 +2201,8 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", - "destinationWishlistUid": "4", + "sourceWishlistUid": 4, + "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } ``` @@ -2221,7 +2227,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Example @@ -2249,7 +2255,7 @@ mutation createBraintreeClientToken { Creates Client Token for Braintree PayPal Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Example @@ -2266,7 +2272,7 @@ mutation createBraintreePayPalClientToken { ```json { "data": { - "createBraintreePayPalClientToken": "xyz789" + "createBraintreePayPalClientToken": "abc123" } } ``` @@ -2277,13 +2283,13 @@ mutation createBraintreePayPalClientToken { Creates Client Token for Braintree PayPal Vault Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `input` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | #### Example @@ -2317,13 +2323,13 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | #### Example @@ -2357,13 +2363,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | #### Example @@ -2397,13 +2403,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | #### Example @@ -2437,13 +2443,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | #### Example @@ -2477,13 +2483,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | #### Example @@ -2533,13 +2539,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -2573,13 +2579,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | #### Example @@ -2642,21 +2648,21 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": true, + "default_billing": false, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", "id": 123, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", + "suffix": "abc123", + "telephone": "xyz789", "vat_id": "xyz789" } } @@ -2669,13 +2675,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2713,13 +2719,13 @@ Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](#string) +**Response:** [`String`](types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2740,7 +2746,7 @@ mutation createEmptyCart($input: createEmptyCartInput) { ##### Response ```json -{"data": {"createEmptyCart": "xyz789"}} +{"data": {"createEmptyCart": "abc123"}} ``` @@ -2749,13 +2755,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2793,13 +2799,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | #### Example @@ -2833,13 +2839,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -2870,10 +2876,10 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { "data": { "createPayflowProToken": { "response_message": "abc123", - "result": 987, - "result_code": 987, - "secure_token": "xyz789", - "secure_token_id": "abc123" + "result": 123, + "result_code": 123, + "secure_token": "abc123", + "secure_token_id": "xyz789" } } } @@ -2885,13 +2891,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -2921,10 +2927,10 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 123.45, + "amount": 987.65, "currency_code": "abc123", "id": "abc123", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "status": "xyz789" } } @@ -2937,13 +2943,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2973,7 +2979,7 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { "data": { "createPaypalExpressToken": { "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" + "token": "abc123" } } } @@ -2985,13 +2991,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -3029,13 +3035,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -3079,13 +3085,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "abc123", + "created_at": "abc123", + "created_by": "xyz789", "description": "abc123", "name": "abc123", "status": "ENABLED", - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } } } @@ -3097,13 +3103,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | #### Example @@ -3143,13 +3149,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Creates a vault payment token -**Response:** [`CreateVaultCardPaymentTokenOutput`](#createvaultcardpaymenttokenoutput) +**Response:** [`CreateVaultCardPaymentTokenOutput`](types-c-e.md#createvaultcardpaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardPaymentTokenInput!`](#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | +| `input` - [`CreateVaultCardPaymentTokenInput!`](types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | #### Example @@ -3179,7 +3185,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } } } @@ -3191,13 +3197,13 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) Creates a vault card setup token -**Response:** [`CreateVaultCardSetupTokenOutput`](#createvaultcardsetuptokenoutput) +**Response:** [`CreateVaultCardSetupTokenOutput`](types-c-e.md#createvaultcardsetuptokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardSetupTokenInput!`](#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | +| `input` - [`CreateVaultCardSetupTokenInput!`](types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | #### Example @@ -3235,13 +3241,13 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -3275,13 +3281,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3304,7 +3310,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyRole": {"success": false}}} +{"data": {"deleteCompanyRole": {"success": true}}} ``` @@ -3313,13 +3319,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3336,13 +3342,13 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": true}}} +{"data": {"deleteCompanyTeam": {"success": false}}} ``` @@ -3355,13 +3361,13 @@ Use deleteCompanyUserV2 instead. The current method only deactivates the user ac Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3378,13 +3384,13 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyUser": {"success": true}}} +{"data": {"deleteCompanyUser": {"success": false}}} ``` @@ -3393,13 +3399,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3431,13 +3437,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3454,13 +3460,13 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response ```json -{"data": {"deleteCompareList": {"result": true}}} +{"data": {"deleteCompareList": {"result": false}}} ``` @@ -3469,7 +3475,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Example @@ -3484,7 +3490,7 @@ mutation deleteCustomer { ##### Response ```json -{"data": {"deleteCustomer": false}} +{"data": {"deleteCustomer": true}} ``` @@ -3493,13 +3499,13 @@ mutation deleteCustomer { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3514,7 +3520,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response @@ -3529,13 +3535,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete a negotiable quote template -**Response:** [`Boolean!`](#boolean) +**Response:** [`Boolean!`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3556,7 +3562,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": true}} +{"data": {"deleteNegotiableQuoteTemplate": false}} ``` @@ -3565,13 +3571,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3624,13 +3630,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3650,7 +3656,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "abc123"} +{"public_hash": "xyz789"} ``` ##### Response @@ -3672,13 +3678,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3718,13 +3724,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3766,14 +3772,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -3799,8 +3805,8 @@ mutation deleteRequisitionListItems( ```json { - "requisitionListUid": "4", - "requisitionListItemUids": [4] + "requisitionListUid": 4, + "requisitionListItemUids": ["4"] } ``` @@ -3822,13 +3828,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -3848,7 +3854,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": "4"} +{"wishlistId": 4} ``` ##### Response @@ -3870,13 +3876,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -3914,13 +3920,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -3965,12 +3971,12 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "estimateShippingMethods": [ { "amount": Money, - "available": true, + "available": false, "base_amount": Money, - "carrier_code": "xyz789", + "carrier_code": "abc123", "carrier_title": "xyz789", "error_message": "abc123", - "method_code": "abc123", + "method_code": "xyz789", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -3986,13 +3992,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -4026,14 +4032,14 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](#customertoken) +**Response:** [`CustomerToken`](types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -4057,8 +4063,8 @@ mutation generateCustomerToken( ```json { - "email": "abc123", - "password": "abc123" + "email": "xyz789", + "password": "xyz789" } ``` @@ -4068,7 +4074,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -4080,13 +4086,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -4124,13 +4130,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -4168,13 +4174,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -4208,14 +4214,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `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. | +| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4313,12 +4319,12 @@ mutation mergeCarts( AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, @@ -4338,14 +4344,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4374,7 +4380,10 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": "4", "giftRegistryUid": 4} +{ + "cartUid": "4", + "giftRegistryUid": "4" +} ``` ##### Response @@ -4397,15 +4406,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4436,8 +4445,8 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": "4", + "sourceRequisitionListUid": "4", + "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4461,13 +4470,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4507,15 +4516,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4575,13 +4584,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4641,14 +4650,14 @@ 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": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -4659,7 +4668,7 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) ], "status": "abc123", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -4671,13 +4680,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4711,13 +4720,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4765,13 +4774,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -4809,13 +4818,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | #### Example @@ -4855,13 +4864,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -4893,7 +4902,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, "code": "xyz789", - "expiration_date": "abc123" + "expiration_date": "xyz789" } } } @@ -4905,13 +4914,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -4955,13 +4964,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4995,13 +5004,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -5035,13 +5044,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -5075,13 +5084,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -5113,14 +5122,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -5145,7 +5154,10 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": 4, "itemsUid": [4]} +{ + "giftRegistryUid": "4", + "itemsUid": ["4"] +} ``` ##### Response @@ -5166,14 +5178,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -5219,13 +5231,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5259,13 +5271,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5305,13 +5317,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5371,13 +5383,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "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, @@ -5387,9 +5399,9 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", - "total_quantity": 123.45 + "status": "abc123", + "template_id": 4, + "total_quantity": 987.65 } } } @@ -5401,13 +5413,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5441,9 +5453,9 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -5455,14 +5467,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5490,7 +5502,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": [4]} +{"wishlistId": 4, "wishlistItemsIds": ["4"]} ``` ##### Response @@ -5512,13 +5524,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5552,13 +5564,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -5577,7 +5589,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -5592,13 +5604,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5632,13 +5644,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5676,13 +5688,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](#string) | | +| `orderNumber` - [`String!`](types-q-s.md#string) | | #### Example @@ -5704,7 +5716,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "xyz789"} +{"orderNumber": "abc123"} ``` ##### Response @@ -5726,13 +5738,13 @@ mutation reorderItems($orderNumber: String!) { Request to cancel specified guest order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderCancelInput!`](#guestordercancelinput) | | +| `input` - [`GuestOrderCancelInput!`](types-f-i.md#guestordercancelinput) | | #### Example @@ -5776,13 +5788,13 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { ### requestGuestReturn -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestGuestReturnInput!`](#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | +| `input` - [`RequestGuestReturnInput!`](types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | #### Example @@ -5826,13 +5838,13 @@ mutation requestGuestReturn($input: RequestGuestReturnInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -5870,13 +5882,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -5953,7 +5965,7 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -5966,13 +5978,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | #### Example @@ -5987,7 +5999,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -6002,13 +6014,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -6052,13 +6064,13 @@ mutation requestReturn($input: RequestReturnInput!) { Resends the confirmation email to a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to send the confirmation email to. | +| `email` - [`String!`](types-q-s.md#string) | The email address to send the confirmation email to. | #### Example @@ -6088,15 +6100,15 @@ mutation resendConfirmationEmail($email: String!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | 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!`](types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | #### Example @@ -6120,8 +6132,8 @@ mutation resetPassword( ```json { - "email": "xyz789", - "resetPasswordToken": "abc123", + "email": "abc123", + "resetPasswordToken": "xyz789", "newPassword": "xyz789" } ``` @@ -6129,7 +6141,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": false}} +{"data": {"resetPassword": true}} ``` @@ -6138,7 +6150,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) #### Example @@ -6155,7 +6167,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": true}}} +{"data": {"revokeCustomerToken": {"result": false}}} ``` @@ -6164,13 +6176,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -6214,13 +6226,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -6260,13 +6272,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -6300,13 +6312,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -6340,13 +6352,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6380,13 +6392,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6420,13 +6432,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6466,13 +6478,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6512,13 +6524,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6558,13 +6570,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6604,13 +6616,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6670,14 +6682,14 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6686,9 +6698,9 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", - "total_quantity": 987.65 + "status": "xyz789", + "template_id": 4, + "total_quantity": 123.45 } } } @@ -6704,13 +6716,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -6758,13 +6770,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -6798,13 +6810,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -6864,14 +6876,14 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "setQuoteTemplateLineItemNote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "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, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6880,7 +6892,7 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", "total_quantity": 123.45 } @@ -6894,13 +6906,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -6934,13 +6946,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -6974,15 +6986,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7008,7 +7020,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7026,13 +7038,13 @@ mutation shareGiftRegistry( Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -7097,7 +7109,7 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -7108,8 +7120,8 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", + "status": "abc123", + "template_id": 4, "total_quantity": 123.45 } } @@ -7122,13 +7134,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -7145,7 +7157,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -7160,13 +7172,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -7196,13 +7208,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Track that a product was viewed in adobe commerce -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `sku` - [`String!`](#string) | The sku for a `ProductInterface` object. | +| `sku` - [`String!`](types-q-s.md#string) | The sku for a `ProductInterface` object. | #### Example @@ -7217,7 +7229,7 @@ mutation trackViewedProduct($sku: String!) { ##### Variables ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` ##### Response @@ -7232,13 +7244,13 @@ mutation trackViewedProduct($sku: String!) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -7282,13 +7294,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | #### Example @@ -7322,13 +7334,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | #### Example @@ -7362,13 +7374,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | #### Example @@ -7402,13 +7414,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | #### Example @@ -7442,13 +7454,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | #### Example @@ -7484,13 +7496,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7524,14 +7536,14 @@ mutation updateCustomer($input: CustomerInput!) { Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7584,7 +7596,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 123, "input": CustomerAddressInput} +{"id": 987, "input": CustomerAddressInput} ``` ##### Response @@ -7601,21 +7613,21 @@ mutation updateCustomerAddress( "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, "default_billing": true, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "abc123", + "firstname": "xyz789", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["xyz789"], "suffix": "abc123", "telephone": "abc123", - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -7627,14 +7639,14 @@ mutation updateCustomerAddress( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -7660,7 +7672,7 @@ mutation updateCustomerEmail( ```json { - "email": "abc123", + "email": "xyz789", "password": "abc123" } ``` @@ -7677,13 +7689,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7717,14 +7729,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -7771,14 +7783,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -7804,7 +7816,7 @@ mutation updateGiftRegistryItems( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "items": [UpdateGiftRegistryItemInput] } ``` @@ -7827,14 +7839,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -7860,7 +7872,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -7883,13 +7895,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -7929,13 +7941,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -7975,14 +7987,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -8011,7 +8023,7 @@ mutation updateProductsInWishlist( ```json { - "wishlistId": "4", + "wishlistId": 4, "wishlistItems": [WishlistItemUpdateInput] } ``` @@ -8035,13 +8047,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -8085,12 +8097,12 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "xyz789", + "created_at": "xyz789", + "created_by": "abc123", "description": "abc123", - "name": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": "4", + "uid": 4, "updated_at": "xyz789" } } @@ -8103,14 +8115,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -8159,14 +8171,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -8217,15 +8229,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to update. | -| `name` - [`String`](#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -8254,7 +8266,7 @@ mutation updateWishlist( ```json { "wishlistId": 4, - "name": "abc123", + "name": "xyz789", "visibility": "PUBLIC" } ``` @@ -8265,8 +8277,8 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "abc123", - "uid": "4", + "name": "xyz789", + "uid": 4, "visibility": "PUBLIC" } } @@ -8279,13 +8291,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | #### Example 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 45a6afc8c..cfbb4c0ea 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](#attributesformoutput) +**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](#string) | Form code. | +| `formCode` - [`String!`](types-q-s.md#string) | Form code. | #### Example @@ -70,14 +70,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -130,13 +130,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](#storeconfig) +**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -401,7 +401,7 @@ query availableStores($useCurrentGroup: Boolean) { ##### Variables ```json -{"useCurrentGroup": false} +{"useCurrentGroup": true} ``` ##### Response @@ -412,250 +412,250 @@ query availableStores($useCurrentGroup: Boolean) { "availableStores": [ { "absolute_footer": "abc123", - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "abc123", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order_items": "xyz789", "allow_guests_to_write_product_reviews": "abc123", "allow_items": "xyz789", "allow_order": "xyz789", - "allow_printed_card": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": false, - "base_currency_code": "abc123", - "base_link_url": "abc123", - "base_media_url": "xyz789", + "base_currency_code": "xyz789", + "base_link_url": "xyz789", + "base_media_url": "abc123", "base_static_url": "xyz789", "base_url": "xyz789", - "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_allowspecific": false, "braintree_3dsecure_always_request_3ds": false, "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "xyz789", - "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": "abc123", "braintree_applepay_vault_active": true, - "braintree_cc_vault_active": "xyz789", - "braintree_cc_vault_cvv": false, - "braintree_environment": "abc123", + "braintree_cc_vault_active": "abc123", + "braintree_cc_vault_cvv": true, + "braintree_environment": "xyz789", "braintree_googlepay_btn_color": "xyz789", - "braintree_googlepay_cctypes": "abc123", - "braintree_googlepay_merchant_id": "xyz789", - "braintree_googlepay_vault_active": false, + "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": "xyz789", + "braintree_local_payment_fallback_button_text": "abc123", "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": "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_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_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_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": "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_paylater_label": "abc123", + "braintree_paypal_button_location_cart_type_paylater_shape": "abc123", + "braintree_paypal_button_location_cart_type_paylater_show": true, + "braintree_paypal_button_location_cart_type_paypal_color": "xyz789", "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", "braintree_paypal_button_location_cart_type_paypal_shape": "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_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": true, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "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": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_show": true, + "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": "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_color": "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_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": "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_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": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789", + "braintree_paypal_button_location_productpage_type_paylater_label": "abc123", "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123", "braintree_paypal_button_location_productpage_type_paylater_show": false, - "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789", + "braintree_paypal_button_location_productpage_type_paypal_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": false, - "braintree_paypal_credit_uk_merchant_name": "abc123", - "braintree_paypal_display_on_shopping_cart": false, - "braintree_paypal_merchant_country": "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": true, + "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": true, - "cart_expires_in_days": 123, + "braintree_paypal_require_billing_address": false, + "braintree_paypal_send_cart_line_items": false, + "braintree_paypal_vault_active": false, + "cart_expires_in_days": 987, "cart_gift_wrapping": "abc123", - "cart_printed_card": "abc123", - "cart_summary_display_quantity": 123, + "cart_printed_card": "xyz789", + "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_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_max_order_total": "abc123", "check_money_order_min_order_total": "xyz789", - "check_money_order_new_order_status": "abc123", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "abc123", + "check_money_order_new_order_status": "xyz789", + "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_send_check_to": "xyz789", "check_money_order_sort_order": 123, - "check_money_order_title": "xyz789", + "check_money_order_title": "abc123", "cms_home_page": "abc123", "cms_no_cookies": "xyz789", "cms_no_route": "xyz789", "code": "abc123", "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "abc123", - "contact_enabled": false, + "contact_enabled": true, "copyright": "xyz789", - "countries_with_required_region": "abc123", - "create_account_confirmation": true, + "countries_with_required_region": "xyz789", + "create_account_confirmation": false, "customer_access_token_lifetime": 123.45, "default_country": "xyz789", "default_description": "abc123", "default_display_currency_code": "abc123", - "default_keywords": "xyz789", + "default_keywords": "abc123", "default_title": "xyz789", - "demonotice": 987, - "display_product_prices_in_catalog": 987, + "demonotice": 123, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, "display_state_if_optional": true, "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": false, "fixed_product_taxes_display_prices_in_emails": 123, "fixed_product_taxes_display_prices_in_product_lists": 987, - "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_display_prices_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, + "fixed_product_taxes_include_fpt_in_subtotal": false, "front": "abc123", "graphql_share_all_customer_groups": false, - "graphql_share_customer_group": true, + "graphql_share_customer_group": false, "grid_per_page": 987, "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", - "head_includes": "xyz789", + "head_includes": "abc123", "head_shortcut_icon": "xyz789", "header_logo_src": "xyz789", - "id": 987, - "is_checkout_agreements_enabled": false, + "id": 123, + "is_checkout_agreements_enabled": true, "is_default_store": false, - "is_default_store_group": true, - "is_guest_checkout_enabled": true, + "is_default_store_group": false, + "is_guest_checkout_enabled": false, "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": false, + "is_one_page_checkout_enabled": true, "is_requisition_list_active": "xyz789", - "list_mode": "abc123", + "list_mode": "xyz789", "list_per_page": 987, "list_per_page_values": "abc123", - "locale": "xyz789", + "locale": "abc123", "logo_alt": "xyz789", - "logo_height": 987, + "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_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_customer_limit": "abc123", + "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "abc123", - "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "xyz789", + "magento_reward_points_newsletter": "xyz789", + "magento_reward_points_order": "abc123", + "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", - "minicart_display": true, - "minicart_max_items": 987, - "minimum_password_length": "abc123", - "newsletter_enabled": true, - "no_route": "abc123", - "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "xyz789", + "minicart_display": false, + "minicart_max_items": 123, + "minimum_password_length": "xyz789", + "newsletter_enabled": false, + "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_full_summary": false, "orders_invoices_credit_memos_display_grandtotal": true, - "orders_invoices_credit_memos_display_price": 987, + "orders_invoices_credit_memos_display_price": 123, "orders_invoices_credit_memos_display_shipping_amount": 123, "orders_invoices_credit_memos_display_subtotal": 987, - "orders_invoices_credit_memos_display_zero_tax": true, - "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "abc123", + "orders_invoices_credit_memos_display_zero_tax": false, + "payment_payflowpro_cc_vault_active": "abc123", + "printed_card_price": "xyz789", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", - "product_url_suffix": "abc123", + "product_reviews_enabled": "abc123", + "product_url_suffix": "xyz789", "quickorder_active": false, "required_character_classes_number": "abc123", - "returns_enabled": "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_gift_wrapping": "abc123", "sales_printed_card": "abc123", "secure_base_link_url": "xyz789", - "secure_base_media_url": "xyz789", + "secure_base_media_url": "abc123", "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, "share_all_catalog_rules": false, - "share_all_sales_rule": true, + "share_all_sales_rule": false, "share_applied_catalog_rules": false, "share_applied_sales_rule": false, - "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_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, + "shopping_cart_display_zero_tax": false, "show_cms_breadcrumbs": 123, "store_code": "4", - "store_group_code": "4", + "store_group_code": 4, "store_group_name": "xyz789", - "store_name": "xyz789", + "store_name": "abc123", "store_sort_order": 987, - "timezone": "xyz789", + "timezone": "abc123", "title_prefix": "xyz789", "title_separator": "xyz789", - "title_suffix": "abc123", + "title_suffix": "xyz789", "use_store_in_url": true, "website_code": "4", - "website_id": 987, - "website_name": "xyz789", + "website_id": 123, + "website_name": "abc123", "weight_unit": "xyz789", "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": false, + "zero_subtotal_enabled": true, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "xyz789" + "zero_subtotal_title": "abc123" } ] } @@ -668,13 +668,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](#cart) +**Response:** [`Cart`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -744,7 +744,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -765,10 +765,10 @@ query cart($cart_id: String!) { "billing_address": BillingCartAddress, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": true, + "id": 4, + "is_virtual": false, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, @@ -776,7 +776,7 @@ query cart($cart_id: String!) { "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -788,15 +788,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](#categoryresult) +**Response:** [`CategoryResult`](types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -842,7 +842,7 @@ query categories( "categories": { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -858,13 +858,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](#categorytree) +**Response:** [`CategoryTree`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -934,43 +934,43 @@ query category($id: Int) { { "data": { "category": { - "automatic_sorting": "xyz789", + "automatic_sorting": "abc123", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "abc123", "children": [CategoryTree], "children_count": "abc123", "cms_block": CmsBlock, - "created_at": "abc123", - "custom_layout_update_file": "abc123", + "created_at": "xyz789", + "custom_layout_update_file": "xyz789", "default_sort_by": "abc123", "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 123.45, - "id": 987, + "id": 123, "image": "xyz789", "include_in_menu": 987, "is_anchor": 123, "landing_page": 987, - "level": 123, + "level": 987, "meta_description": "abc123", - "meta_keywords": "abc123", + "meta_keywords": "xyz789", "meta_title": "abc123", - "name": "abc123", + "name": "xyz789", "path": "abc123", - "path_in_store": "xyz789", + "path_in_store": "abc123", "position": 123, - "product_count": 987, + "product_count": 123, "products": CategoryProducts, "redirect_code": 987, - "relative_url": "abc123", + "relative_url": "xyz789", "staged": false, "type": "CMS_PAGE", "uid": 4, - "updated_at": "xyz789", + "updated_at": "abc123", "url_key": "xyz789", - "url_path": "abc123", - "url_suffix": "abc123" + "url_path": "xyz789", + "url_suffix": "xyz789" } } } @@ -986,15 +986,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](#categorytree) +**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -1080,17 +1080,17 @@ query categoryList( "automatic_sorting": "xyz789", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "abc123", "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", - "description": "xyz789", + "default_sort_by": "abc123", + "description": "abc123", "display_mode": "abc123", "filter_price_range": 123.45, - "id": 987, + "id": 123, "image": "xyz789", "include_in_menu": 987, "is_anchor": 987, @@ -1100,18 +1100,18 @@ query categoryList( "meta_keywords": "abc123", "meta_title": "xyz789", "name": "xyz789", - "path": "xyz789", + "path": "abc123", "path_in_store": "abc123", - "position": 123, - "product_count": 123, + "position": 987, + "product_count": 987, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", - "staged": false, + "staged": true, "type": "CMS_PAGE", "uid": "4", - "updated_at": "abc123", - "url_key": "xyz789", + "updated_at": "xyz789", + "url_key": "abc123", "url_path": "xyz789", "url_suffix": "abc123" } @@ -1126,7 +1126,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) #### Example @@ -1153,11 +1153,11 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 987, - "checkbox_text": "xyz789", + "agreement_id": 123, + "checkbox_text": "abc123", "content": "abc123", - "content_height": "xyz789", - "is_html": true, + "content_height": "abc123", + "is_html": false, "mode": "AUTO", "name": "abc123" } @@ -1172,13 +1172,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](#cmsblocks) +**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -1197,7 +1197,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["xyz789"]} +{"identifiers": ["abc123"]} ``` ##### Response @@ -1212,14 +1212,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](#cmspage) +**Response:** [`CmsPage`](types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The ID of the CMS page. | -| `identifier` - [`String`](#string) | The identifier of the CMS page. | +| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -1253,7 +1253,7 @@ query cmsPage( ##### Variables ```json -{"id": 123, "identifier": "xyz789"} +{"id": 987, "identifier": "abc123"} ``` ##### Response @@ -1265,15 +1265,15 @@ query cmsPage( "content": "abc123", "content_heading": "abc123", "identifier": "xyz789", - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keywords": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "page_layout": "xyz789", - "redirect_code": 123, - "relative_url": "abc123", - "title": "abc123", + "redirect_code": 987, + "relative_url": "xyz789", + "title": "xyz789", "type": "CMS_PAGE", - "url_key": "abc123" + "url_key": "xyz789" } } } @@ -1285,7 +1285,7 @@ query cmsPage( Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](#company) +**Response:** [`Company`](types-c-e.md#company) #### Example @@ -1351,13 +1351,13 @@ query company { "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "xyz789", + "email": "abc123", "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "abc123", - "payment_methods": ["xyz789"], - "reseller_id": "xyz789", + "name": "xyz789", + "payment_methods": ["abc123"], + "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1365,7 +1365,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } } } @@ -1377,13 +1377,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1407,7 +1407,7 @@ query compareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -1419,7 +1419,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -1431,7 +1431,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](#country) +**Response:** [`[Country]`](types-c-e.md#country) #### Example @@ -1462,9 +1462,9 @@ query countries { "available_regions": [Region], "full_name_english": "abc123", "full_name_locale": "abc123", - "id": "abc123", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "id": "xyz789", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "abc123" } ] } @@ -1477,13 +1477,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](#country) +**Response:** [`Country`](types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](#string) | | +| `id` - [`String`](types-q-s.md#string) | | #### Example @@ -1517,11 +1517,11 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", + "full_name_english": "xyz789", "full_name_locale": "xyz789", - "id": "xyz789", + "id": "abc123", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } } } @@ -1533,7 +1533,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](#currency) +**Response:** [`Currency`](types-c-e.md#currency) #### Example @@ -1565,12 +1565,12 @@ query currency { "available_currency_codes": [ "abc123" ], - "base_currency_code": "xyz789", + "base_currency_code": "abc123", "base_currency_symbol": "abc123", "default_display_currecy_code": "xyz789", - "default_display_currecy_symbol": "abc123", - "default_display_currency_code": "abc123", - "default_display_currency_symbol": "abc123", + "default_display_currecy_symbol": "xyz789", + "default_display_currency_code": "xyz789", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } } @@ -1587,13 +1587,13 @@ Use `customAttributeMetadataV2` query instead. Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1631,13 +1631,13 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | #### Example @@ -1681,7 +1681,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Example @@ -1809,22 +1809,22 @@ query customer { "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "xyz789", - "default_shipping": "xyz789", + "default_shipping": "abc123", "dob": "abc123", "email": "abc123", "firstname": "xyz789", - "gender": 987, + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroup, "group_id": 123, "id": 123, "is_subscribed": true, - "job_title": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", + "job_title": "abc123", + "lastname": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -1844,9 +1844,9 @@ query customer { "store_credit": CustomerStoreCredit, "structure_id": 4, "suffix": "abc123", - "taxvat": "abc123", + "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1861,7 +1861,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Example @@ -1944,20 +1944,20 @@ 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, + "printed_card_included": false, "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1969,7 +1969,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) #### Example @@ -2005,7 +2005,7 @@ query customerDownloadableProducts { Use the `customer` query instead. -**Response:** [`CustomerOrders`](#customerorders) +**Response:** [`CustomerOrders`](types-c-e.md#customerorders) #### Example @@ -2035,7 +2035,7 @@ query customerOrders { "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -2047,7 +2047,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) #### Example @@ -2079,15 +2079,15 @@ query customerPaymentTokens { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](#dynamicblocks) +**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -2145,13 +2145,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](#hostedprourl) +**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -2189,13 +2189,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](#payflowlinktoken) +**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2227,7 +2227,7 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "mode": "TEST", "paypal_url": "abc123", "secure_token": "abc123", - "secure_token_id": "xyz789" + "secure_token_id": "abc123" } } } @@ -2239,13 +2239,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2297,14 +2297,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | #### Example @@ -2344,10 +2344,10 @@ query getPaymentOrder( { "data": { "getPaymentOrder": { - "id": "xyz789", - "mp_order_id": "xyz789", + "id": "abc123", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "status": "abc123" } } } @@ -2359,13 +2359,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2403,7 +2403,7 @@ query getPaymentSDK($location: PaymentLocation!) { Retrieves the vault configuration -**Response:** [`VaultConfigOutput`](#vaultconfigoutput) +**Response:** [`VaultConfigOutput`](types-t-z.md#vaultconfigoutput) #### Example @@ -2437,13 +2437,13 @@ query getVaultConfig { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -2475,7 +2475,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "abc123", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -2487,13 +2487,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](#giftregistry) +**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -2531,7 +2531,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -2540,11 +2540,11 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "abc123", + "event_name": "xyz789", "items": [GiftRegistryItemInterface], "message": "abc123", "owner_name": "xyz789", @@ -2553,7 +2553,7 @@ query giftRegistry($giftRegistryUid: ID!) { "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } } } @@ -2565,13 +2565,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | #### Example @@ -2593,7 +2593,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2603,12 +2603,12 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "abc123", - "gift_registry_uid": 4, + "gift_registry_uid": "4", "location": "xyz789", - "name": "abc123", - "type": "abc123" + "name": "xyz789", + "type": "xyz789" } ] } @@ -2621,13 +2621,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -2649,7 +2649,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -2661,10 +2661,10 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { { "event_date": "xyz789", "event_title": "abc123", - "gift_registry_uid": 4, - "location": "xyz789", - "name": "abc123", - "type": "xyz789" + "gift_registry_uid": "4", + "location": "abc123", + "name": "xyz789", + "type": "abc123" } ] } @@ -2677,15 +2677,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](#string) | The first name of the registrant. | -| `lastName` - [`String!`](#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](#id) | The type UID of the registry. | +| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2717,8 +2717,8 @@ query giftRegistryTypeSearch( ```json { "firstName": "abc123", - "lastName": "xyz789", - "giftRegistryTypeUid": "4" + "lastName": "abc123", + "giftRegistryTypeUid": 4 } ``` @@ -2732,9 +2732,9 @@ query giftRegistryTypeSearch( "event_date": "abc123", "event_title": "abc123", "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", - "type": "xyz789" + "location": "xyz789", + "name": "abc123", + "type": "abc123" } ] } @@ -2747,7 +2747,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](#giftregistrytype) +**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) #### Example @@ -2789,13 +2789,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and billing last name. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderInformationInput!`](#orderinformationinput) | | +| `input` - [`OrderInformationInput!`](types-k-p.md#orderinformationinput) | | #### Example @@ -2891,7 +2891,7 @@ query guestOrder($input: OrderInformationInput!) { "billing_address": OrderAddress, "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, "email": "abc123", @@ -2905,8 +2905,8 @@ query guestOrder($input: OrderInformationInput!) { "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", - "order_date": "xyz789", + "number": "xyz789", + "order_date": "abc123", "order_number": "abc123", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], @@ -2929,13 +2929,13 @@ query guestOrder($input: OrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | #### Example @@ -3031,24 +3031,24 @@ query guestOrderByToken($input: OrderTokenInput!) { "billing_address": OrderAddress, "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "abc123", + "created_at": "xyz789", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, + "grand_total": 987.65, "id": 4, - "increment_id": "abc123", + "increment_id": "xyz789", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", - "order_date": "abc123", + "number": "abc123", + "order_date": "xyz789", "order_number": "abc123", - "order_status_change_date": "xyz789", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, @@ -3056,7 +3056,7 @@ query guestOrderByToken($input: OrderTokenInput!) { "shipping_address": OrderAddress, "shipping_method": "xyz789", "status": "xyz789", - "token": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -3069,13 +3069,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -3092,13 +3092,13 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} ``` @@ -3107,13 +3107,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -3130,7 +3130,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3145,13 +3145,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](#string) | | +| `name` - [`String!`](types-q-s.md#string) | | #### Example @@ -3183,13 +3183,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -3206,13 +3206,13 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}} ``` @@ -3221,13 +3221,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to check. | +| `email` - [`String!`](types-q-s.md#string) | The email address to check. | #### Example @@ -3250,7 +3250,7 @@ query isEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": true}}} +{"data": {"isEmailAvailable": {"is_email_available": false}}} ``` @@ -3259,13 +3259,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](#negotiablequote) +**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | | +| `uid` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3332,7 +3332,7 @@ query negotiableQuote($uid: ID!) { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "email": "xyz789", + "email": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], @@ -3344,7 +3344,7 @@ query negotiableQuote($uid: ID!) { ], "status": "SUBMITTED", "total_quantity": 987.65, - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -3357,13 +3357,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](#id) | | +| `templateId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3412,7 +3412,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": "4"} +{"templateId": 4} ``` ##### Response @@ -3423,14 +3423,14 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "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, - "name": "xyz789", + "max_order_commitment": 987, + "min_order_commitment": 987, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -3439,9 +3439,9 @@ query negotiableQuoteTemplate($templateId: ID!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -3453,16 +3453,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -3515,7 +3515,7 @@ query negotiableQuoteTemplates( "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -3527,16 +3527,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3589,7 +3589,7 @@ query negotiableQuotes( "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -3601,18 +3601,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](#pickuplocations) +**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3679,7 +3679,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) #### Example @@ -3713,17 +3713,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](#products) +**Response:** [`Products`](types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -3771,7 +3771,7 @@ query products( ```json { - "search": "abc123", + "search": "xyz789", "filter": ProductAttributeFilterInput, "pageSize": 20, "currentPage": 1, @@ -3791,7 +3791,7 @@ query products( "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } } } @@ -3801,13 +3801,13 @@ query products( ### recaptchaFormConfig -**Response:** [`ReCaptchaConfigOutput`](#recaptchaconfigoutput) +**Response:** [`ReCaptchaConfigOutput`](types-q-s.md#recaptchaconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `formType` - [`ReCaptchaFormEnum!`](#recaptchaformenum) | | +| `formType` - [`ReCaptchaFormEnum!`](types-q-s.md#recaptchaformenum) | | #### Example @@ -3849,7 +3849,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3876,13 +3876,13 @@ query recaptchaV3Config { { "data": { "recaptchaV3Config": { - "badge_position": "abc123", + "badge_position": "xyz789", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": true, + "is_enabled": false, "language_code": "xyz789", - "minimum_score": 987.65, - "theme": "xyz789", + "minimum_score": 123.45, + "theme": "abc123", "website_key": "abc123" } } @@ -3895,13 +3895,13 @@ query recaptchaV3Config { Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](#routableinterface) +**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3929,7 +3929,7 @@ query route($url: String!) { { "data": { "route": { - "redirect_code": 123, + "redirect_code": 987, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -3943,7 +3943,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](#storeconfig) +**Response:** [`StoreConfig`](types-q-s.md#storeconfig) #### Example @@ -4211,186 +4211,186 @@ query storeConfig { { "data": { "storeConfig": { - "absolute_footer": "xyz789", - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "xyz789", + "absolute_footer": "abc123", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "abc123", - "allow_order": "abc123", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": true, + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "xyz789", + "allow_order": "xyz789", + "allow_printed_card": "xyz789", + "autocomplete_on_storefront": false, "base_currency_code": "xyz789", "base_link_url": "abc123", - "base_media_url": "abc123", - "base_static_url": "xyz789", - "base_url": "xyz789", - "braintree_3dsecure_allowspecific": true, + "base_media_url": "xyz789", + "base_static_url": "abc123", + "base_url": "abc123", + "braintree_3dsecure_allowspecific": false, "braintree_3dsecure_always_request_3ds": true, "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "abc123", - "braintree_3dsecure_verify_3dsecure": false, + "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": "xyz789", + "braintree_cc_vault_active": "abc123", "braintree_cc_vault_cvv": true, - "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "xyz789", + "braintree_environment": "abc123", + "braintree_googlepay_btn_color": "abc123", "braintree_googlepay_cctypes": "abc123", - "braintree_googlepay_merchant_id": "xyz789", - "braintree_googlepay_vault_active": false, + "braintree_googlepay_merchant_id": "abc123", + "braintree_googlepay_vault_active": true, "braintree_local_payment_allowed_methods": "xyz789", - "braintree_local_payment_fallback_button_text": "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": "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_color": "xyz789", + "braintree_paypal_button_location_cart_type_credit_label": "abc123", + "braintree_paypal_button_location_cart_type_credit_shape": "xyz789", "braintree_paypal_button_location_cart_type_credit_show": true, - "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", + "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": "abc123", - "braintree_paypal_button_location_cart_type_messaging_show": true, + "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": "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_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_label": "xyz789", "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_show": true, - "braintree_paypal_button_location_checkout_type_credit_color": "abc123", - "braintree_paypal_button_location_checkout_type_credit_label": "abc123", + "braintree_paypal_button_location_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": "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_credit_show": true, + "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", + "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_show": true, "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", + "braintree_paypal_button_location_checkout_type_paylater_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_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": "xyz789", + "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", + "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123", "braintree_paypal_button_location_checkout_type_paypal_show": false, - "braintree_paypal_button_location_productpage_type_credit_color": "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": false, - "braintree_paypal_button_location_productpage_type_messaging_layout": "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": "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_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_color": "abc123", "braintree_paypal_button_location_productpage_type_paylater_label": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_show": true, - "braintree_paypal_button_location_productpage_type_paypal_color": "abc123", + "braintree_paypal_button_location_productpage_type_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": "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": "abc123", + "braintree_paypal_merchant_name_override": "xyz789", "braintree_paypal_require_billing_address": false, "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": true, + "braintree_paypal_vault_active": false, "cart_expires_in_days": 123, - "cart_gift_wrapping": "abc123", + "cart_gift_wrapping": "xyz789", "cart_printed_card": "abc123", - "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "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", + "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": false, "check_money_order_enabled": true, - "check_money_order_make_check_payable_to": "abc123", + "check_money_order_make_check_payable_to": "xyz789", "check_money_order_max_order_total": "abc123", - "check_money_order_min_order_total": "abc123", + "check_money_order_min_order_total": "xyz789", "check_money_order_new_order_status": "xyz789", "check_money_order_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 123, - "check_money_order_title": "abc123", - "cms_home_page": "abc123", - "cms_no_cookies": "xyz789", + "check_money_order_sort_order": 987, + "check_money_order_title": "xyz789", + "cms_home_page": "xyz789", + "cms_no_cookies": "abc123", "cms_no_route": "xyz789", "code": "xyz789", "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "abc123", - "contact_enabled": false, - "copyright": "xyz789", - "countries_with_required_region": "xyz789", + "contact_enabled": true, + "copyright": "abc123", + "countries_with_required_region": "abc123", "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, + "customer_access_token_lifetime": 987.65, "default_country": "xyz789", - "default_description": "xyz789", - "default_display_currency_code": "abc123", - "default_keywords": "xyz789", - "default_title": "abc123", - "demonotice": 987, + "default_description": "abc123", + "default_display_currency_code": "xyz789", + "default_keywords": "abc123", + "default_title": "xyz789", + "demonotice": 123, "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": true, - "enable_multiple_wishlists": "xyz789", + "display_state_if_optional": false, + "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_in_product_lists": 123, + "fixed_product_taxes_display_prices_in_sales_modules": 123, "fixed_product_taxes_display_prices_on_product_view_page": 987, "fixed_product_taxes_enable": false, - "fixed_product_taxes_include_fpt_in_subtotal": true, - "front": "xyz789", + "fixed_product_taxes_include_fpt_in_subtotal": false, + "front": "abc123", "graphql_share_all_customer_groups": false, - "graphql_share_customer_group": true, + "graphql_share_customer_group": false, "grid_per_page": 987, - "grid_per_page_values": "xyz789", + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", "head_includes": "xyz789", - "head_shortcut_icon": "abc123", - "header_logo_src": "abc123", + "head_shortcut_icon": "xyz789", + "header_logo_src": "xyz789", "id": 123, - "is_checkout_agreements_enabled": false, - "is_default_store": false, - "is_default_store_group": true, - "is_guest_checkout_enabled": true, + "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": false, "is_requisition_list_active": "abc123", "list_mode": "abc123", - "list_per_page": 123, + "list_per_page": 987, "list_per_page_values": "xyz789", "locale": "xyz789", "logo_alt": "xyz789", "logo_height": 987, - "logo_width": 123, + "logo_width": 987, "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_points_invitation_customer": "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_invitation_order": "abc123", + "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_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": 123, - "maximum_number_of_wishlists": "abc123", - "minicart_display": false, + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "xyz789", + "minicart_display": true, "minicart_max_items": 123, "minimum_password_length": "xyz789", - "newsletter_enabled": false, + "newsletter_enabled": true, "no_route": "abc123", "optional_zip_countries": "abc123", "order_cancellation_enabled": false, @@ -4399,60 +4399,60 @@ query storeConfig { "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, - "payment_payflowpro_cc_vault_active": "xyz789", + "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_zero_tax": true, + "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "xyz789", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "abc123", + "product_reviews_enabled": "xyz789", "product_url_suffix": "xyz789", "quickorder_active": true, "required_character_classes_number": "xyz789", "returns_enabled": "xyz789", - "root_category_id": 987, - "root_category_uid": 4, + "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": "xyz789", "secure_base_media_url": "xyz789", "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "share_all_catalog_rules": true, "share_all_sales_rule": false, - "share_applied_catalog_rules": false, - "share_applied_sales_rule": true, - "shopping_cart_display_full_summary": true, + "share_applied_catalog_rules": true, + "share_applied_sales_rule": 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": 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, + "shopping_cart_display_zero_tax": true, + "show_cms_breadcrumbs": 123, "store_code": 4, - "store_group_code": 4, - "store_group_name": "abc123", + "store_group_code": "4", + "store_group_name": "xyz789", "store_name": "abc123", - "store_sort_order": 987, + "store_sort_order": 123, "timezone": "xyz789", - "title_prefix": "abc123", + "title_prefix": "xyz789", "title_separator": "abc123", - "title_suffix": "abc123", + "title_suffix": "xyz789", "use_store_in_url": true, - "website_code": 4, - "website_id": 987, - "website_name": "xyz789", + "website_code": "4", + "website_id": 123, + "website_name": "abc123", "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": "abc123", - "zero_subtotal_sort_order": 987, + "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": 123, "zero_subtotal_title": "xyz789" } } @@ -4469,13 +4469,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](#entityurl) +**Response:** [`EntityUrl`](types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4497,7 +4497,7 @@ query urlResolver($url: String!) { ##### Variables ```json -{"url": "abc123"} +{"url": "xyz789"} ``` ##### Response @@ -4507,9 +4507,9 @@ query urlResolver($url: String!) { "data": { "urlResolver": { "canonical_url": "abc123", - "entity_uid": 4, + "entity_uid": "4", "id": 987, - "redirectCode": 123, + "redirectCode": 987, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -4527,7 +4527,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](#wishlistoutput) +**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) #### Example @@ -4554,10 +4554,10 @@ query wishlist { "data": { "wishlist": { "items": [WishlistItem], - "items_count": 123, - "name": "xyz789", - "sharing_code": "abc123", - "updated_at": "xyz789" + "items_count": 987, + "name": "abc123", + "sharing_code": "xyz789", + "updated_at": "abc123" } } } 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 index 789acd99e..d37e9b545 100644 --- 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 @@ -8,7 +8,7 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -26,7 +26,7 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example @@ -48,7 +48,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -66,14 +66,14 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [ConfigurableProductCartItemInput] } ``` @@ -88,7 +88,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -104,14 +104,14 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [DownloadableProductCartItemInput] } ``` @@ -126,7 +126,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -144,10 +144,10 @@ Defines a new registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | #### Example @@ -156,9 +156,9 @@ Defines a new registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "abc123", - "firstname": "xyz789", - "lastname": "abc123" + "email": "xyz789", + "firstname": "abc123", + "lastname": "xyz789" } ``` @@ -172,7 +172,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -190,8 +190,8 @@ Contains details about the cart after adding products to it. | 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. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | #### Example @@ -212,8 +212,8 @@ Contains products to add to an existing compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example @@ -231,7 +231,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -249,8 +249,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -271,15 +271,15 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { - "comment": "abc123", - "purchase_order_uid": 4 + "comment": "xyz789", + "purchase_order_uid": "4" } ``` @@ -293,7 +293,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -311,17 +311,17 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "purchase_order_uid": "4", - "replace_existing_cart_items": true + "replace_existing_cart_items": false } ``` @@ -335,14 +335,14 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | +| `message` - [`String!`](types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "type": "OUT_OF_STOCK" } ``` @@ -377,7 +377,7 @@ Output of the request to add items in a requisition list to the cart. | 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. | +| `cart` - [`Cart`](types-c-e.md#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 @@ -402,16 +402,13 @@ Defines a return comment. | 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. | +| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example ```json -{ - "comment_text": "abc123", - "return_uid": "4" -} +{"comment_text": "xyz789", "return_uid": 4} ``` @@ -424,7 +421,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `return` - [`Return`](types-q-s.md#return) | The modified return. | #### Example @@ -442,16 +439,16 @@ Defines tracking information to be added to the return. | 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. | +| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { - "carrier_uid": 4, - "return_uid": "4", + "carrier_uid": "4", + "return_uid": 4, "tracking_number": "xyz789" } ``` @@ -466,8 +463,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -488,8 +485,8 @@ Defines the simple and group products to add to the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example @@ -510,7 +507,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -528,8 +525,8 @@ Defines the virtual products to add to the cart. | 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_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example @@ -550,7 +547,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -568,9 +565,9 @@ Contains the resultant wish list and any error information. | 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. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#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. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -594,19 +591,19 @@ Contains information for each filterable option (such as price, category `UID`, | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](types-q-s.md#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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example ```json { "attribute_code": "xyz789", - "count": 123, - "label": "xyz789", + "count": 987, + "label": "abc123", "options": [AggregationOption], "position": 987 } @@ -622,16 +619,16 @@ An implementation of `AggregationOptionInterface`. | 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example ```json { "count": 987, - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -646,9 +643,9 @@ Defines aggregation option 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -711,25 +708,25 @@ An input object that specifies the filters used in product aggregations. | 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 | +| `code` - [`String`](types-q-s.md#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 | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": ButtonStyles, - "code": "xyz789", + "code": "abc123", "is_visible": true, "payment_intent": "abc123", "payment_source": "abc123", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "title": "abc123" } ``` @@ -744,9 +741,9 @@ Apple Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example @@ -768,7 +765,7 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example @@ -786,17 +783,17 @@ Contains an applied gift card with applied and remaining balance. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "applied_balance": Money, - "code": "xyz789", + "code": "abc123", "current_balance": Money, "expiration_date": "xyz789" } @@ -812,8 +809,8 @@ Contains the applied and current balances. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](types-k-p.md#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 @@ -822,7 +819,7 @@ Contains the applied and current balances. { "applied_balance": Money, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -836,15 +833,15 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | #### Example ```json { - "cart_id": "abc123", - "coupon_code": "abc123" + "cart_id": "xyz789", + "coupon_code": "xyz789" } ``` @@ -858,7 +855,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -895,16 +892,16 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](types-q-s.md#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"], + "cart_id": "abc123", + "coupon_codes": ["xyz789"], "type": "APPEND" } ``` @@ -919,15 +916,15 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example ```json { - "cart_id": "abc123", - "gift_card_code": "abc123" + "cart_id": "xyz789", + "gift_card_code": "xyz789" } ``` @@ -941,7 +938,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -959,8 +956,8 @@ Contains applied gift cards with gift card code and amount. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](#string) | The gift card account code. | +| `applied_balance` - [`Money!`](types-k-p.md#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](types-q-s.md#string) | The gift card account code. | #### Example @@ -981,7 +978,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -999,12 +996,12 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -1017,7 +1014,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -1035,13 +1032,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | 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. | +| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 123, "search_term": "xyz789"} +{"radius": 987, "search_term": "abc123"} ``` @@ -1054,7 +1051,7 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | | `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | #### Example @@ -1073,20 +1070,20 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](types-q-s.md#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. | +| `attribute_type` - [`String`](types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "attribute_options": [AttributeOption], - "attribute_type": "abc123", + "attribute_type": "xyz789", "entity_type": "xyz789", "input_type": "abc123", "storefront_properties": StorefrontProperties @@ -1142,15 +1139,15 @@ An input object that specifies the filters used for attributes. ```json { - "is_comparable": true, - "is_filterable": true, - "is_filterable_in_search": true, + "is_comparable": false, + "is_filterable": false, + "is_filterable_in_search": false, "is_html_allowed_on_front": false, "is_searchable": false, - "is_used_for_customer_segment": 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_used_for_promo_rules": true, + "is_visible_in_advanced_search": false, "is_visible_on_front": true, "is_wysiwyg_enabled": false, "used_in_product_listing": true @@ -1200,15 +1197,15 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | #### Example ```json { "attribute_code": "xyz789", - "entity_type": "xyz789" + "entity_type": "abc123" } ``` @@ -1222,12 +1219,12 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1240,27 +1237,27 @@ Base EAV implementation of CustomAttributeMetadataInterface. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#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_class` - [`String`](types-q-s.md#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. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example ```json { - "code": 4, - "default_value": "abc123", + "code": "4", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "is_required": false, - "is_unique": false, + "is_unique": true, "label": "abc123", "options": [CustomAttributeOptionInterface] } @@ -1276,7 +1273,7 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example @@ -1319,14 +1316,14 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](types-q-s.md#string) | The attribute option value. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -1342,16 +1339,16 @@ Base EAV implementation of CustomAttributeOptionInterface. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example ```json { - "is_default": false, + "is_default": true, "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -1363,15 +1360,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Example ```json { "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1383,8 +1380,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1409,7 +1406,7 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example @@ -1429,13 +1426,16 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The attribute value. | #### Example ```json -{"code": 4, "value": "xyz789"} +{ + "code": "4", + "value": "xyz789" +} ``` @@ -1448,15 +1448,15 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#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. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "selected_options": [AttributeInputSelectedOption], "value": "xyz789" } @@ -1470,7 +1470,7 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1496,7 +1496,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1518,7 +1518,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1539,13 +1539,13 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | #### Example ```json -{"code": "AFN", "symbol": "xyz789"} +{"code": "AFN", "symbol": "abc123"} ``` @@ -1558,9 +1558,9 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `title` - [`String!`](types-q-s.md#string) | The payment method title. | #### Example @@ -1568,7 +1568,7 @@ Describes a payment method that the shopper can use to pay for the order. { "code": "abc123", "is_deferred": false, - "title": "xyz789" + "title": "abc123" } ``` @@ -1582,29 +1582,29 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example ```json { "amount": Money, - "available": true, + "available": false, "base_amount": Money, "carrier_code": "xyz789", "carrier_title": "xyz789", "error_message": "abc123", - "method_code": "abc123", - "method_title": "abc123", + "method_code": "xyz789", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1638,8 +1638,8 @@ Defines the billing address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](types-f-i.md#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. | @@ -1648,9 +1648,9 @@ Defines the billing address. ```json { "address": CartAddressInput, - "customer_address_id": 987, + "customer_address_id": 123, "same_as_shipping": true, - "use_for_shipping": false + "use_for_shipping": true } ``` @@ -1664,12 +1664,12 @@ The billing address information | 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 | +| `address_line_1` - [`String`](types-q-s.md#string) | The first line of the address | +| `address_line_2` - [`String`](types-q-s.md#string) | The second line of the address | +| `city` - [`String`](types-q-s.md#string) | The city of the address | +| `country_code` - [`String!`](types-q-s.md#string) | The country of the address | +| `postal_code` - [`String`](types-q-s.md#string) | The postal code of the address | +| `region` - [`String`](types-q-s.md#string) | The region of the address | #### Example @@ -1679,8 +1679,8 @@ The billing address information "address_line_2": "abc123", "city": "abc123", "country_code": "abc123", - "postal_code": "abc123", - "region": "abc123" + "postal_code": "xyz789", + "region": "xyz789" } ``` @@ -1694,24 +1694,24 @@ Contains details about the billing address. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](types-c-e.md#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. | +| `customer_notes` - [`String`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example @@ -1721,14 +1721,14 @@ Contains details about the billing address. "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_notes": "xyz789", - "fax": "abc123", - "firstname": "xyz789", - "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "customer_notes": "abc123", + "fax": "xyz789", + "firstname": "abc123", + "id": 123, + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CartAddressRegion, "street": ["xyz789"], "suffix": "abc123", @@ -1744,12 +1744,6 @@ Contains details about the billing address. The `Boolean` scalar type represents `true` or `false`. -#### Example - -```json -true -``` - ### BraintreeCcVaultInput @@ -1758,14 +1752,14 @@ true | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `device_data` - [`String`](types-q-s.md#string) | | +| `public_hash` - [`String!`](types-q-s.md#string) | | #### Example ```json { - "device_data": "abc123", + "device_data": "xyz789", "public_hash": "xyz789" } ``` @@ -1778,17 +1772,17 @@ true | 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. | +| `device_data` - [`String`](types-q-s.md#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. | +| `payment_method_nonce` - [`String!`](types-q-s.md#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" + "is_active_payment_token_enabler": true, + "payment_method_nonce": "abc123" } ``` @@ -1800,15 +1794,15 @@ true | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `device_data` - [`String`](types-q-s.md#string) | | +| `public_hash` - [`String!`](types-q-s.md#string) | | #### Example ```json { "device_data": "abc123", - "public_hash": "abc123" + "public_hash": "xyz789" } ``` @@ -1822,12 +1816,12 @@ Contains details about an individual category that comprises a breadcrumb. | 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. | +| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](types-f-i.md#int) | The category level. | +| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | #### Example @@ -1837,8 +1831,8 @@ Contains details about an individual category that comprises a breadcrumb. "category_level": 987, "category_name": "abc123", "category_uid": "4", - "category_url_key": "xyz789", - "category_url_path": "xyz789" + "category_url_key": "abc123", + "category_url_path": "abc123" } ``` @@ -1852,24 +1846,24 @@ An implementation for bundle product cart items. | 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.)* | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#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. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1882,16 +1876,16 @@ An implementation for bundle product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": false, - "max_qty": 987.65, - "min_qty": 987.65, + "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": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -1906,14 +1900,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -1923,7 +1917,7 @@ Defines bundle product options for `CreditMemoItemInterface`. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_refunded": 987.65 @@ -1940,14 +1934,14 @@ Defines bundle product options for `InvoiceItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1955,12 +1949,12 @@ Defines bundle product options for `InvoiceItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "product_sku": "abc123", + "quantity_invoiced": 123.45 } ``` @@ -1974,15 +1968,15 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](types-f-i.md#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 | +| `position` - [`Int`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](types-k-p.md#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. | +| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example @@ -1990,13 +1984,13 @@ Defines an individual item within a bundle product. { "option_id": 123, "options": [BundleItemOption], - "position": 987, + "position": 123, "price_range": PriceRange, - "required": true, + "required": false, "sku": "abc123", - "title": "abc123", - "type": "xyz789", - "uid": 4 + "title": "xyz789", + "type": "abc123", + "uid": "4" } ``` @@ -2011,32 +2005,32 @@ Defines the characteristics that comprise a specific bundle item and its options | 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)* | +| `id` - [`Int`](types-f-i.md#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. | +| `label` - [`String`](types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": true, + "can_change_quantity": false, "id": 123, - "is_default": false, - "label": "xyz789", + "is_default": true, + "label": "abc123", "position": 123, "price": 123.45, "price_type": "FIXED", "product": ProductInterface, - "qty": 123.45, - "quantity": 123.45, - "uid": 4 + "qty": 987.65, + "quantity": 987.65, + "uid": "4" } ``` @@ -2050,17 +2044,17 @@ Defines the input for a bundle option. | 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. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | #### Example ```json { - "id": 123, - "quantity": 987.65, - "value": ["xyz789"] + "id": 987, + "quantity": 123.45, + "value": ["abc123"] } ``` @@ -2074,30 +2068,30 @@ Defines bundle product options for `OrderItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -2105,15 +2099,15 @@ Defines bundle product options for `OrderItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "product_type": "xyz789", @@ -2121,12 +2115,12 @@ Defines bundle product options for `OrderItemInterface`. "quantity_canceled": 987.65, "quantity_invoiced": 987.65, "quantity_ordered": 123.45, - "quantity_refunded": 987.65, + "quantity_refunded": 123.45, "quantity_return_requested": 987.65, "quantity_returned": 123.45, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -2140,98 +2134,98 @@ Defines basic features of a bundle product and contains multiple BundleItems. | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#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. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#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. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2239,48 +2233,48 @@ Defines basic features of a bundle product and contains multiple BundleItems. { "activity": "abc123", "attribute_set_id": 123, - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "abc123", "climate": "abc123", - "collar": "xyz789", - "color": 987, + "collar": "abc123", + "color": 123, "country_of_manufacture": "abc123", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "dynamic_price": false, "dynamic_sku": false, "dynamic_weight": false, - "eco_collection": 123, + "eco_collection": 987, "erin_recommends": 987, "features_bags": "abc123", "format": 123, - "gender": "abc123", + "gender": "xyz789", "gift_message_available": true, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 123, + "id": 987, "image": ProductImage, "is_returnable": "xyz789", "items": [BundleItem], "manufacturer": 987, - "material": "abc123", - "max_sale_qty": 987.65, + "material": "xyz789", + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "abc123", + "name": "xyz789", "new": 123, "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "pattern": "abc123", "performance_fabric": 987, "price": ProductPrices, @@ -2292,43 +2286,43 @@ Defines basic features of a bundle product and contains multiple BundleItems. "purpose": 123, "quantity": 987.65, "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, + "relative_url": "abc123", + "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], "sale": 987, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, "size": 987, - "sku": "abc123", + "sku": "xyz789", "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "xyz789", - "staged": true, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "abc123", + "staged": false, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "abc123", - "style_general": "xyz789", + "style_general": "abc123", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", - "uid": 4, - "updated_at": "abc123", + "type_id": "xyz789", + "uid": "4", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -2343,8 +2337,8 @@ Defines a single bundle product. | 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -2366,11 +2360,11 @@ Contains details about bundle products added to a requisition list. | 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. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2379,8 +2373,8 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -2394,25 +2388,25 @@ Defines bundle product options for `ShipmentItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example ```json { "bundle_options": [ItemSelectedBundleOption], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 987.65 + "quantity_shipped": 123.45 } ``` @@ -2426,23 +2420,23 @@ Defines bundle product options for `WishlistItemInterface`. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": 4, + "id": "4", "product": ProductInterface, "quantity": 987.65 } @@ -2456,11 +2450,11 @@ Defines bundle product options for `WishlistItemInterface`. | 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 | +| `color` - [`String`](types-q-s.md#string) | The button color | +| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](types-q-s.md#string) | The button label | +| `layout` - [`String`](types-q-s.md#string) | The button layout | +| `shape` - [`String`](types-q-s.md#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 | @@ -2468,13 +2462,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "xyz789", + "color": "abc123", "height": 123, - "label": "xyz789", - "layout": "abc123", - "shape": "abc123", - "tagline": true, - "use_default_height": true + "label": "abc123", + "layout": "xyz789", + "shape": "xyz789", + "tagline": false, + "use_default_height": false } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md index 95b05482f..92f27014f 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md @@ -8,15 +8,15 @@ Specifies the quote template id of the quote template to cancel | 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. | +| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "cancellation_comment": "abc123", - "template_id": 4 + "template_id": "4" } ``` @@ -29,7 +29,7 @@ Specifies the quote template id of the quote template to cancel | Field Name | Description | |------------|-------------| | `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -71,15 +71,15 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](#string) | Cancellation reason. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | #### Example ```json { "order_id": "4", - "reason": "xyz789" + "reason": "abc123" } ``` @@ -93,7 +93,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | | `errorV2` - [`CancelOrderError`](#cancelordererror) | | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | @@ -101,7 +101,7 @@ Contains the updated customer order and error message if any. ```json { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -115,7 +115,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](#string) | | +| `description` - [`String!`](types-q-s.md#string) | | #### Example @@ -132,10 +132,10 @@ Contains the updated customer order and error message if any. | 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 | +| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](types-q-s.md#string) | Name on the card | #### Example @@ -143,9 +143,9 @@ Contains the updated customer order and error message if any. { "bin_details": CardBin, "card_expiry_month": "abc123", - "card_expiry_year": "xyz789", - "last_digits": "xyz789", - "name": "xyz789" + "card_expiry_year": "abc123", + "last_digits": "abc123", + "name": "abc123" } ``` @@ -157,12 +157,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `bin` - [`String`](types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "abc123"} +{"bin": "xyz789"} ``` @@ -175,8 +175,8 @@ The card payment source information | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](#string) | The name on the cardholder | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](types-q-s.md#string) | The name on the cardholder | #### Example @@ -197,16 +197,16 @@ The card payment source information | 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 | +| `brand` - [`String`](types-q-s.md#string) | The brand of the card | +| `expiry` - [`String`](types-q-s.md#string) | The expiry of the card | +| `last_digits` - [`String`](types-q-s.md#string) | The last digits of the card | #### Example ```json { - "brand": "abc123", - "expiry": "abc123", + "brand": "xyz789", + "expiry": "xyz789", "last_digits": "xyz789" } ``` @@ -221,28 +221,28 @@ Contains the contents and other details about a guest or customer cart. | 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. | +| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](types-a-b.md#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. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#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. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -256,20 +256,20 @@ Contains the contents and other details about a guest or customer cart. "available_gift_wrappings": [GiftWrapping], "available_payment_methods": [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": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } ``` @@ -283,15 +283,15 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `code` - [`String!`](types-q-s.md#string) | The country code. | +| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | #### Example ```json { "code": "xyz789", - "label": "xyz789" + "label": "abc123" } ``` @@ -305,37 +305,37 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "abc123", - "company": "xyz789", - "country_code": "xyz789", + "city": "xyz789", + "company": "abc123", + "country_code": "abc123", "custom_attributes": [AttributeValueInput], - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": "abc123", "region_id": 987, @@ -343,7 +343,7 @@ Defines the billing or shipping address to be applied to the cart. "street": ["abc123"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -355,50 +355,50 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | +| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | #### Example ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "id": 987, "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "abc123", "uid": "abc123", "vat_id": "abc123" } @@ -414,9 +414,9 @@ Contains details about the region in a billing or shipping address. | 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`](types-q-s.md#string) | The state or province code. | +| `label` - [`String`](types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -424,7 +424,7 @@ Contains details about the region in a billing or shipping address. { "code": "xyz789", "label": "xyz789", - "region_id": 987 + "region_id": 123 } ``` @@ -438,8 +438,8 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | #### Example @@ -476,12 +476,12 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | #### Example ```json -{"code": "UNDEFINED", "message": "xyz789"} +{"code": "UNDEFINED", "message": "abc123"} ``` @@ -513,10 +513,10 @@ Defines an item to be added to the cart. | 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. | +| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | #### Example @@ -524,8 +524,8 @@ Defines an item to be added to the cart. { "entered_options": [EnteredOptionInput], "parent_sku": "abc123", - "quantity": 123.45, - "selected_options": [4], + "quantity": 987.65, + "selected_options": ["4"], "sku": "abc123" } ``` @@ -542,28 +542,28 @@ An interface for products in a cart. |------------|-------------| | `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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | +| [`SimpleCartItem`](types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | +| [`BundleCartItem`](types-a-b.md#bundlecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | +| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | #### Example @@ -571,17 +571,17 @@ An interface for products in a cart. { "discount": [Discount], "errors": [CartItemError], - "id": "abc123", + "id": "xyz789", "is_available": true, "max_qty": 123.45, - "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, - "uid": 4 + "quantity": 123.45, + "uid": "4" } ``` @@ -595,17 +595,17 @@ Contains details about the price of the item, including taxes and discounts. | 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. | +| `catalog_discount` - [`ProductDiscount`](types-k-p.md#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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](types-k-p.md#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -635,13 +635,13 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | 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`.)* | +| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart_item_id": 987, "quantity": 123.45} +{"cart_item_id": 123, "quantity": 987.65} ``` @@ -654,9 +654,9 @@ Contains details about the price of a selected customizable value. | 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. | +| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](types-f-i.md#float) | A price value. | #### Example @@ -678,19 +678,19 @@ A single item to be updated. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | #### Example ```json { "cart_item_id": 987, - "cart_item_uid": "4", + "cart_item_uid": 4, "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": "4", @@ -707,8 +707,8 @@ A single item to be updated. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | #### Example @@ -716,7 +716,7 @@ A single item to be updated. { "items": [CartItemInterface], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -733,12 +733,12 @@ Contains details about the final price of items in the cart, including discount | `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. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -764,12 +764,12 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | Name of the cart price rule | +| `name` - [`String!`](types-q-s.md#string) | Name of the cart price rule | #### Example ```json -{"name": "abc123"} +{"name": "xyz789"} ``` @@ -782,15 +782,15 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | #### Example ```json { "amount": Money, - "label": "abc123" + "label": "xyz789" } ``` @@ -803,7 +803,7 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -870,29 +870,29 @@ Swatch attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](types-q-s.md#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. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example @@ -906,22 +906,22 @@ Swatch attribute metadata. "frontend_input": "BOOLEAN", "is_comparable": false, "is_filterable": false, - "is_filterable_in_search": false, + "is_filterable_in_search": true, "is_html_allowed_on_front": true, - "is_required": true, + "is_required": false, "is_searchable": false, "is_unique": true, "is_used_for_price_rules": true, - "is_used_for_promo_rules": true, + "is_used_for_promo_rules": false, "is_visible_in_advanced_search": true, - "is_visible_on_front": true, - "is_wysiwyg_enabled": false, - "label": "abc123", + "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 + "use_product_image_for_swatch": false, + "used_in_product_listing": true } ``` @@ -933,12 +933,12 @@ Swatch attribute metadata. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | Name of the catalog rule | +| `name` - [`String!`](types-q-s.md#string) | Name of the catalog rule | #### Example ```json -{"name": "xyz789"} +{"name": "abc123"} ``` @@ -951,13 +951,13 @@ Defines the filters to be used in the search. A filter contains at least one att | 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. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -983,39 +983,39 @@ Contains the full set of attributes that can be returned in a category search. | 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) | | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -1027,38 +1027,38 @@ Contains the full set of attributes that can be returned in a category search. ```json { - "automatic_sorting": "abc123", - "available_sort_by": ["abc123"], + "automatic_sorting": "xyz789", + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", - "children_count": "abc123", + "canonical_url": "xyz789", + "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "abc123", - "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", - "description": "abc123", + "created_at": "xyz789", + "custom_layout_update_file": "abc123", + "default_sort_by": "xyz789", + "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 123.45, "id": 123, - "image": "xyz789", + "image": "abc123", "include_in_menu": 987, - "is_anchor": 987, - "landing_page": 123, + "is_anchor": 123, + "landing_page": 987, "level": 987, - "meta_description": "abc123", - "meta_keywords": "abc123", + "meta_description": "xyz789", + "meta_keywords": "xyz789", "meta_title": "xyz789", "name": "abc123", - "path": "xyz789", - "path_in_store": "abc123", + "path": "abc123", + "path_in_store": "xyz789", "position": 987, - "product_count": 987, + "product_count": 123, "products": CategoryProducts, - "staged": false, + "staged": true, "uid": 4, - "updated_at": "xyz789", - "url_key": "xyz789", - "url_path": "abc123", + "updated_at": "abc123", + "url_key": "abc123", + "url_path": "xyz789", "url_suffix": "abc123" } ``` @@ -1073,9 +1073,9 @@ Contains details about the products assigned to a category. | 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. | +| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -1098,8 +1098,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -1107,7 +1107,7 @@ Contains a collection of `CategoryTree` objects and pagination information. { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1121,84 +1121,84 @@ Contains the hierarchy of categories. | 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. | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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) | | +| `children_count` - [`String`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "automatic_sorting": "xyz789", - "available_sort_by": ["abc123"], + "automatic_sorting": "abc123", + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", + "canonical_url": "xyz789", "children": [CategoryTree], "children_count": "abc123", "cms_block": CmsBlock, "created_at": "xyz789", - "custom_layout_update_file": "abc123", + "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", - "description": "abc123", + "description": "xyz789", "display_mode": "abc123", "filter_price_range": 123.45, - "id": 987, - "image": "abc123", - "include_in_menu": 987, + "id": 123, + "image": "xyz789", + "include_in_menu": 123, "is_anchor": 123, "landing_page": 987, - "level": 987, + "level": 123, "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", - "path": "abc123", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "path": "xyz789", "path_in_store": "abc123", - "position": 123, + "position": 987, "product_count": 123, "products": CategoryProducts, - "redirect_code": 123, - "relative_url": "xyz789", - "staged": true, + "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": "abc123", + "url_path": "xyz789", "url_suffix": "xyz789" } ``` @@ -1213,13 +1213,13 @@ Defines details about an individual checkout agreement. | 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. | +| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](types-a-b.md#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. | +| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | #### Example @@ -1228,10 +1228,10 @@ Defines details about an individual checkout agreement. "agreement_id": 987, "checkbox_text": "xyz789", "content": "xyz789", - "content_height": "xyz789", + "content_height": "abc123", "is_html": true, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ``` @@ -1265,8 +1265,8 @@ An error encountered while adding an item to the cart. | 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 | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](types-q-s.md#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 @@ -1274,7 +1274,7 @@ An error encountered while adding an item to the cart. { "code": "REORDER_NOT_AVAILABLE", "message": "xyz789", - "path": ["xyz789"] + "path": ["abc123"] } ``` @@ -1308,13 +1308,13 @@ Contains details about errors encountered when a customer clear cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | | `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{"message": "xyz789", "type": "NOT_FOUND"} ``` @@ -1346,7 +1346,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Cart` object. | #### Example @@ -1387,7 +1387,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -1403,9 +1403,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -1424,7 +1424,7 @@ Contains details about a failed close operation on a negotiable quote. | 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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1443,7 +1443,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1462,7 +1462,7 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example @@ -1480,10 +1480,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | 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 | +| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1508,9 +1508,9 @@ Contains details about a specific CMS block. | 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. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | #### Example @@ -1550,18 +1550,18 @@ Contains details about a CMS page. | 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`. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example @@ -1571,14 +1571,14 @@ Contains details about a CMS page. "content_heading": "abc123", "identifier": "abc123", "meta_description": "abc123", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "abc123", - "page_layout": "xyz789", - "redirect_code": 987, + "page_layout": "abc123", + "redirect_code": 123, "relative_url": "xyz789", - "title": "abc123", + "title": "xyz789", "type": "CMS_PAGE", - "url_key": "abc123" + "url_key": "xyz789" } ``` @@ -1590,7 +1590,7 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -1627,7 +1627,7 @@ Specifies which field to sort on, and whether to return the results in ascending | 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. | +| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1649,13 +1649,13 @@ Contains the output schema for a 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](types-f-i.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](types-q-s.md#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. | @@ -1663,7 +1663,7 @@ Contains the output schema for a company. | `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. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1673,13 +1673,13 @@ Contains the output schema for a company. "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "xyz789", - "id": "4", + "email": "abc123", + "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "xyz789", + "name": "abc123", "payment_methods": ["xyz789"], - "reseller_id": "abc123", + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1702,18 +1702,18 @@ Contains details about the access control list settings of a resource. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | #### Example ```json { "children": [CompanyAclResource], - "id": "4", - "sort_order": 987, - "text": "abc123" + "id": 4, + "sort_order": 123, + "text": "xyz789" } ``` @@ -1727,25 +1727,25 @@ Defines the input schema for creating a company administrator. | 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. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company administrator. | #### Example ```json { "custom_attributes": [AttributeValueInput], - "email": "abc123", - "firstname": "abc123", + "email": "xyz789", + "firstname": "xyz789", "gender": 123, - "job_title": "abc123", + "job_title": "xyz789", "lastname": "xyz789", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1759,17 +1759,17 @@ The minimal required information to identify and display the company. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | #### Example ```json { - "id": 4, + "id": "4", "legal_name": "xyz789", - "name": "xyz789" + "name": "abc123" } ``` @@ -1784,12 +1784,12 @@ Defines the input schema for creating a new company. | 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. | +| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1815,9 +1815,9 @@ Contains company credit balances and limits. | 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. | +| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](types-k-p.md#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 @@ -1840,8 +1840,8 @@ Contains details about prior company credit operations. | 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. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1849,7 +1849,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1863,9 +1863,9 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](types-q-s.md#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. | +| `updated_by` - [`String`](types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example @@ -1873,7 +1873,7 @@ Defines a filter for narrowing the results of a credit history search. { "custom_reference_number": "abc123", "operation_type": "ALLOCATION", - "updated_by": "xyz789" + "updated_by": "abc123" } ``` @@ -1887,10 +1887,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `amount` - [`Money`](types-k-p.md#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. | +| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](types-q-s.md#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. | @@ -1901,7 +1901,7 @@ Contains details about a single company credit operation. "amount": Money, "balance": CompanyCredit, "custom_reference_number": "abc123", - "date": "abc123", + "date": "xyz789", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser } @@ -1938,13 +1938,13 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](types-q-s.md#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"} +{"name": "abc123", "type": "CUSTOMER"} ``` @@ -1974,16 +1974,16 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | +| `code` - [`String!`](types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "code": "xyz789", - "role_id": 4, + "code": "abc123", + "role_id": "4", "user": CompanyInvitationUserInput } ``` @@ -1998,12 +1998,12 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -2016,18 +2016,18 @@ Company user attributes in the invitation. | 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. | +| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | #### Example ```json { - "company_id": "4", - "customer_id": "4", + "company_id": 4, + "customer_id": 4, "job_title": "xyz789", "status": "ACTIVE", "telephone": "abc123" @@ -2044,12 +2044,12 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | #### Example @@ -2074,23 +2074,23 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](types-q-s.md#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. | +| `postcode` - [`String!`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["abc123"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2104,12 +2104,12 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2117,10 +2117,10 @@ Defines the input schema for updating a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["abc123"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2134,16 +2134,16 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#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. | +| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { - "id": "4", + "id": 4, "name": "abc123", "permissions": [CompanyAclResource], "users_count": 987 @@ -2160,14 +2160,14 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "name": "abc123", + "name": "xyz789", "permissions": ["abc123"] } ``` @@ -2182,16 +2182,16 @@ Defines the input schema for updating a company role. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { "id": "4", - "name": "abc123", + "name": "xyz789", "permissions": ["xyz789"] } ``` @@ -2207,8 +2207,8 @@ Contains an array of roles. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2230,15 +2230,15 @@ Contains details about a company sales representative. | 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "firstname": "abc123", "lastname": "xyz789" } @@ -2290,16 +2290,16 @@ Defines an individual node in the company structure. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example ```json { "entity": CompanyTeam, - "id": 4, - "parent_id": "4" + "id": "4", + "parent_id": 4 } ``` @@ -2313,13 +2313,13 @@ Defines the input schema for updating the company structure. | 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. | +| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": 4, "tree_id": 4} +{"parent_tree_id": "4", "tree_id": 4} ``` @@ -2332,18 +2332,18 @@ Describes a company team. | 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 | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | #### Example ```json { "description": "xyz789", - "id": 4, - "name": "abc123", + "id": "4", + "name": "xyz789", "structure_id": "4" } ``` @@ -2358,9 +2358,9 @@ Defines the input schema for creating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example @@ -2382,17 +2382,17 @@ Defines the input schema for updating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | #### Example ```json { "description": "abc123", - "id": "4", - "name": "abc123" + "id": 4, + "name": "xyz789" } ``` @@ -2406,12 +2406,12 @@ Defines the input schema for updating a company. | 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. | +| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -2421,8 +2421,8 @@ Defines the input schema for updating a company. "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, "legal_name": "abc123", - "reseller_id": "abc123", - "vat_tax_id": "xyz789" + "reseller_id": "xyz789", + "vat_tax_id": "abc123" } ``` @@ -2436,24 +2436,24 @@ Defines the input schema for creating a company user. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](types-f-i.md#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. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "abc123", - "job_title": "xyz789", + "job_title": "abc123", "lastname": "abc123", - "role_id": 4, + "role_id": "4", "status": "ACTIVE", "target_id": "4", "telephone": "abc123" @@ -2489,27 +2489,27 @@ Defines the input schema for updating a company user. | 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. | +| `email` - [`String`](types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](types-f-i.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { "email": "xyz789", - "firstname": "abc123", - "id": 4, - "job_title": "abc123", + "firstname": "xyz789", + "id": "4", + "job_title": "xyz789", "lastname": "xyz789", - "role_id": "4", + "role_id": 4, "status": "ACTIVE", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2524,8 +2524,8 @@ Contains details about company users. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | #### Example @@ -2533,7 +2533,7 @@ Contains details about company users. { "items": [Customer], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2565,15 +2565,15 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | #### Example ```json { - "code": "abc123", - "label": "abc123" + "code": "xyz789", + "label": "xyz789" } ``` @@ -2587,9 +2587,9 @@ Defines an object used to iterate through items for product comparisons. | 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. | +| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2597,7 +2597,7 @@ Defines an object used to iterate through items for product comparisons. { "attributes": [ProductAttribute], "product": ProductInterface, - "uid": 4 + "uid": "4" } ``` @@ -2612,18 +2612,18 @@ Contains iterable information such as the array of items, the count, and attribu | 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. | +| `item_count` - [`Int!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } ``` @@ -2635,7 +2635,7 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | #### Example @@ -2653,19 +2653,19 @@ Contains details about a configurable product attribute option. | 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. | +| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example ```json { "code": "abc123", - "label": "xyz789", + "label": "abc123", "uid": "4", - "value_index": 987 + "value_index": 123 } ``` @@ -2679,25 +2679,25 @@ An implementation for configurable product cart items. | 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. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2711,9 +2711,9 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", + "id": "abc123", "is_available": false, - "max_qty": 987.65, + "max_qty": 123.45, "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], @@ -2721,7 +2721,7 @@ An implementation for configurable product cart items. "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -2735,15 +2735,15 @@ Describes configurable options that have been selected and can be selected as a | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { - "attribute_code": "abc123", - "option_value_uids": [4] + "attribute_code": "xyz789", + "option_value_uids": ["4"] } ``` @@ -2756,35 +2756,35 @@ Describes configurable options that have been selected and can be selected as a | 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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example ```json { "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -2795,17 +2795,17 @@ Describes configurable options that have been selected and can be selected as a "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, + "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": 123.45, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -2819,138 +2819,138 @@ Defines basic features of a configurable product and its simple product variants | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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.)* | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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`](types-f-i.md#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 | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "abc123", - "attribute_set_id": 123, + "activity": "xyz789", + "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "abc123", + "category_gear": "xyz789", + "climate": "xyz789", "collar": "abc123", "color": 987, "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "eco_collection": 987, + "eco_collection": 123, "erin_recommends": 123, - "features_bags": "abc123", + "features_bags": "xyz789", "format": 987, "gender": "xyz789", - "gift_message_available": true, - "gift_wrapping_available": false, + "gift_message_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "id": 987, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 987, + "manufacturer": 123, "material": "xyz789", - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", - "new": 123, - "new_from_date": "abc123", - "new_to_date": "xyz789", + "name": "abc123", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "xyz789", @@ -2961,29 +2961,29 @@ Defines basic features of a configurable product and its simple product variants "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 123, - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 987.65, "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, - "size": 123, - "sku": "xyz789", + "size": 987, + "sku": "abc123", "sleeve": "abc123", "small_image": ProductImage, "special_from_date": "abc123", - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "xyz789", - "style_bottom": "xyz789", - "style_general": "abc123", + "style_bags": "abc123", + "style_bottom": "abc123", + "style_general": "xyz789", "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, @@ -2991,15 +2991,15 @@ Defines basic features of a configurable product and its simple product variants "type": "CMS_PAGE", "type_id": "xyz789", "uid": "4", - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "abc123", - "url_path": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "variants": [ConfigurableVariant], "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -3013,8 +3013,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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) | | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](types-q-s.md#string) | | #### Example @@ -3037,18 +3037,18 @@ Contains details about configurable product options. | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](types-f-i.md#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, + "attribute_code": "abc123", + "label": "xyz789", + "uid": "4", "values": [ConfigurableProductOptionValue] } ``` @@ -3063,19 +3063,19 @@ Defines a value for a configurable product option. | 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. | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | #### Example ```json { - "is_available": true, + "is_available": false, "is_use_default": true, - "label": "xyz789", + "label": "abc123", "swatch": SwatchDataInterface, "uid": 4 } @@ -3091,31 +3091,31 @@ Defines configurable attributes for the specified 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](types-a-b.md#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": "abc123", - "attribute_id_v2": 987, - "attribute_uid": 4, + "attribute_code": "abc123", + "attribute_id": "xyz789", + "attribute_id_v2": 123, + "attribute_uid": "4", "id": 987, - "label": "xyz789", - "position": 123, + "label": "abc123", + "position": 987, "product_id": 987, - "uid": "4", + "uid": 4, "use_default": true, "values": [ConfigurableProductOptionsValues] } @@ -3132,9 +3132,9 @@ Contains metadata corresponding to the selected configurable options. | 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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#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. | +| `variant` - [`SimpleProduct`](types-q-s.md#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 @@ -3159,13 +3159,13 @@ Contains the index number assigned to a configurable product option. | 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.)* | +| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example @@ -3177,7 +3177,7 @@ Contains the index number assigned to a configurable product option. "swatch_data": SwatchDataInterface, "uid": "4", "use_default_value": false, - "value_index": 987 + "value_index": 123 } ``` @@ -3191,11 +3191,11 @@ Contains details about configurable products added to a requisition list. | 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. | +| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -3204,7 +3204,7 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -3220,7 +3220,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -3241,15 +3241,15 @@ A configurable product wish list 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -3260,8 +3260,8 @@ A configurable product wish list item. "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -3275,8 +3275,8 @@ A configurable product wish list item. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | #### Example @@ -3297,14 +3297,14 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | #### Example ```json { - "confirmation_key": "abc123", + "confirmation_key": "xyz789", "email": "xyz789" } ``` @@ -3317,15 +3317,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | #### Example ```json { - "confirmation_key": "abc123", - "order_id": 4 + "confirmation_key": "xyz789", + "order_id": "4" } ``` @@ -3356,18 +3356,18 @@ List of account confirmation statuses. | 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. | +| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | #### Example ```json { "comment": "abc123", - "email": "abc123", - "name": "xyz789", + "email": "xyz789", + "name": "abc123", "telephone": "xyz789" } ``` @@ -3382,7 +3382,7 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example @@ -3400,7 +3400,7 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example @@ -3418,7 +3418,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3436,9 +3436,9 @@ Contains the source and target wish lists after copying products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3458,12 +3458,12 @@ Contains the source and target wish lists after copying products. | 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. | +| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example @@ -3471,8 +3471,8 @@ Contains the source and target wish lists after copying products. { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "abc123", + "full_name_locale": "xyz789", + "id": "xyz789", "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" } @@ -3822,12 +3822,12 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example ```json -{"products": ["4"]} +{"products": [4]} ``` @@ -3840,14 +3840,14 @@ Defines a new gift registry. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3858,7 +3858,7 @@ Defines a new gift registry. ], "event_name": "xyz789", "gift_registry_type_uid": 4, - "message": "abc123", + "message": "xyz789", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -3876,7 +3876,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3892,12 +3892,12 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | #### Example ```json -{"cart_uid": 4} +{"cart_uid": "4"} ``` @@ -3926,21 +3926,21 @@ Contains the secure information used to authorize transaction. Applies to Payflo | 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. | +| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { "response_message": "abc123", - "result": 123, + "result": 987, "result_code": 987, - "secure_token": "abc123", - "secure_token_id": "abc123" + "secure_token": "xyz789", + "secure_token_id": "xyz789" } ``` @@ -3954,11 +3954,11 @@ Contains payment order details that are used while processing the payment order | 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 | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example @@ -3982,19 +3982,19 @@ Contains payment order details that are used while processing the payment order | 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 | +| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example ```json { - "amount": 987.65, + "amount": 123.45, "currency_code": "abc123", - "id": "abc123", + "id": "xyz789", "mp_order_id": "abc123", "status": "abc123" } @@ -4010,11 +4010,11 @@ Defines a new product review. | 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. | +| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example @@ -4022,9 +4022,9 @@ Defines a new product review. { "nickname": "xyz789", "ratings": [ProductReviewRatingInput], - "sku": "xyz789", - "summary": "abc123", - "text": "abc123" + "sku": "abc123", + "summary": "xyz789", + "text": "xyz789" } ``` @@ -4038,7 +4038,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | #### Example @@ -4057,7 +4057,7 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example @@ -4076,9 +4076,9 @@ Defines a set of conditions that apply to a rule. | 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. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -4101,8 +4101,8 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | #### Example @@ -4123,7 +4123,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -4141,8 +4141,8 @@ Describe the variables needed to create a vault payment token | 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 | +| `card_description` - [`String`](types-q-s.md#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example @@ -4163,8 +4163,8 @@ The vault token id and information about the payment source | Field Name | Description | |------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](#string) | The vault payment token information | +| `payment_source` - [`PaymentSourceOutput!`](types-k-p.md#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](types-q-s.md#string) | The vault payment token information | #### Example @@ -4185,8 +4185,8 @@ Describe the variables needed to create a vault card setup token | Input Field | Description | |-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | +| `setup_token` - [`VaultSetupTokenInput!`](types-t-z.md#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | The 3DS mode | #### Example @@ -4207,12 +4207,12 @@ The setup token id information | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](#string) | The setup token id | +| `setup_token` - [`String!`](types-q-s.md#string) | The setup token id | #### Example ```json -{"setup_token": "abc123"} +{"setup_token": "xyz789"} ``` @@ -4225,13 +4225,13 @@ Defines the name and visibility of a new wish list. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json -{"name": "xyz789", "visibility": "PUBLIC"} +{"name": "abc123", "visibility": "PUBLIC"} ``` @@ -4244,7 +4244,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -4262,19 +4262,19 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | 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. | +| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | #### Example ```json { "cc_exp_month": 987, - "cc_exp_year": 987, + "cc_exp_year": 123, "cc_last_4": 123, - "cc_type": "abc123" + "cc_type": "xyz789" } ``` @@ -4288,10 +4288,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](types-f-i.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -4299,9 +4299,9 @@ Contains credit memo details. ```json { "comments": [SalesCommentItem], - "id": "4", + "id": 4, "items": [CreditMemoItemInterface], - "number": "abc123", + "number": "xyz789", "total": CreditMemoTotal } ``` @@ -4315,12 +4315,12 @@ Contains credit memo details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -4331,7 +4331,7 @@ Contains credit memo details. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 } ``` @@ -4347,20 +4347,20 @@ Credit memo item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | +| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -4368,11 +4368,11 @@ Credit memo item details. ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 } ``` @@ -4387,15 +4387,15 @@ Contains credit memo price details. | 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. | +| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](types-k-p.md#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. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4421,13 +4421,13 @@ Contains credit memo price details. | 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 $. | +| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](types-q-s.md#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 @@ -4436,10 +4436,10 @@ Contains credit memo price details. { "available_currency_codes": ["abc123"], "base_currency_code": "abc123", - "base_currency_symbol": "xyz789", - "default_display_currecy_code": "abc123", + "base_currency_symbol": "abc123", + "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "abc123", + "default_display_currency_code": "xyz789", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } @@ -4642,7 +4642,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | #### Example @@ -4660,36 +4660,36 @@ An interface containing fields that define the EAV attribute. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](#attributemetadata) | +| [`AttributeMetadata`](types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | #### Example ```json { - "code": 4, + "code": "4", "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "abc123", "frontend_input": "BOOLEAN", - "is_required": true, - "is_unique": true, + "is_required": false, + "is_unique": false, "label": "abc123", "options": [CustomAttributeOptionInterface] } @@ -4703,23 +4703,23 @@ An interface containing fields that define the EAV attribute. | 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. | +| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | #### Example ```json { "is_default": true, - "label": "xyz789", - "value": "abc123" + "label": "abc123", + "value": "xyz789" } ``` @@ -4735,53 +4735,53 @@ Defines the customer name, addresses, and other details. |------------|-------------| | `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. | +| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](types-t-z.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#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. | +| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#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. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](types-q-s.md#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). | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#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 @@ -4795,8 +4795,8 @@ Defines the customer name, addresses, and other details. "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "xyz789", + "date_of_birth": "abc123", + "default_billing": "abc123", "default_shipping": "xyz789", "dob": "xyz789", "email": "abc123", @@ -4805,20 +4805,20 @@ Defines the customer name, addresses, and other details. "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroup, - "group_id": 123, + "group_id": 987, "id": 987, - "is_subscribed": true, + "is_subscribed": false, "job_title": "abc123", "lastname": "xyz789", "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, + "purchase_orders_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -4832,7 +4832,7 @@ Defines the customer name, addresses, and other details. "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -4849,54 +4849,54 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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.)* | +| `country_id` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#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. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", + "city": "abc123", "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": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "id": 987, - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", "vat_id": "abc123" @@ -4913,15 +4913,15 @@ Specifies the attribute code and value of a customer address attribute. | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example ```json { - "attribute_code": "abc123", - "value": "xyz789" + "attribute_code": "xyz789", + "value": "abc123" } ``` @@ -4935,8 +4935,8 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | #### Example @@ -4957,48 +4957,48 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country_code": "AF", "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], "custom_attributesV2": [AttributeValueInput], - "default_billing": false, - "default_shipping": true, + "default_billing": true, + "default_shipping": false, "fax": "xyz789", "firstname": "abc123", "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "xyz789", "vat_id": "abc123" } ``` @@ -5013,17 +5013,17 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "region": "abc123", - "region_code": "abc123", - "region_id": 123 + "region_code": "xyz789", + "region_id": 987 } ``` @@ -5037,17 +5037,17 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "xyz789", + "region": "abc123", "region_code": "abc123", - "region_id": 987 + "region_id": 123 } ``` @@ -5060,8 +5060,8 @@ Defines the customer's state or province. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer addresses. | #### Example @@ -5069,7 +5069,7 @@ Defines the customer's state or province. { "items": [CustomerAddress], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5083,34 +5083,34 @@ Customer attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](types-f-i.md#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. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": 4, - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", "is_required": false, "is_unique": true, - "label": "xyz789", - "multiline_count": 123, + "label": "abc123", + "multiline_count": 987, "options": [CustomAttributeOptionInterface], "sort_order": 123, "validate_rules": [ValidationRule] @@ -5127,38 +5127,38 @@ An input object for creating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", "dob": "xyz789", - "email": "xyz789", + "email": "abc123", "firstname": "abc123", "gender": 987, "is_subscribed": false, - "lastname": "abc123", - "middlename": "xyz789", - "password": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", + "password": "abc123", "prefix": "xyz789", - "suffix": "xyz789", + "suffix": "abc123", "taxvat": "abc123" } ``` @@ -5173,21 +5173,21 @@ Contains details about a single downloadable product. | 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`. | +| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { "date": "abc123", - "download_url": "xyz789", - "order_increment_id": "abc123", - "remaining_downloads": "xyz789", - "status": "xyz789" + "download_url": "abc123", + "order_increment_id": "xyz789", + "remaining_downloads": "abc123", + "status": "abc123" } ``` @@ -5219,7 +5219,7 @@ Data of customer group. | Field Name | Description | |------------|-------------| -| `name` - [`String`](#string) | The name of customer group. | +| `name` - [`String`](types-q-s.md#string) | The name of customer group. | #### Example @@ -5237,34 +5237,34 @@ An input object that assigns or updates customer attributes. | 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). | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "dob": "xyz789", - "email": "abc123", - "firstname": "xyz789", + "email": "xyz789", + "firstname": "abc123", "gender": 123, - "is_subscribed": true, + "is_subscribed": false, "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "password": "xyz789", - "prefix": "abc123", - "suffix": "abc123", + "prefix": "xyz789", + "suffix": "xyz789", "taxvat": "abc123" } ``` @@ -5279,39 +5279,39 @@ Contains details about each of the customer's orders. | 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.)* | +| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](types-k-p.md#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](types-q-s.md#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. | +| `customer_info` - [`OrderCustomerInfo!`](types-k-p.md#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `order_status_change_date` - [`String!`](types-q-s.md#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -5323,30 +5323,30 @@ Contains details about each of the customer's orders. "billing_address": OrderAddress, "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "abc123", + "created_at": "xyz789", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "grand_total": 123.45, - "id": 4, - "increment_id": "abc123", + "id": "4", + "increment_id": "xyz789", "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", + "number": "abc123", "order_date": "abc123", "order_number": "abc123", "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", + "shipping_method": "xyz789", "status": "abc123", "token": "abc123", "total": OrderTotal @@ -5363,7 +5363,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](types-q-s.md#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 @@ -5401,10 +5401,10 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| -| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | +| `date_of_first_order` - [`String`](types-q-s.md#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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | #### Example @@ -5427,10 +5427,10 @@ Identifies the filter to use for filtering orders. | 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. | +| `grand_total` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filters by order status. | #### Example @@ -5471,7 +5471,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5490,8 +5490,8 @@ Customer segment. | 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. | +| `description` - [`String`](types-q-s.md#string) | Customer segment description. | +| `name` - [`String!`](types-q-s.md#string) | Customer segment name. | #### Example @@ -5534,8 +5534,8 @@ Contains store credit information with balance and history. | 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. | +| `current_balance` - [`Money`](types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5543,7 +5543,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -5558,8 +5558,8 @@ Lists changes to the amount of store credit available to the customer. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | #### Example @@ -5581,10 +5581,10 @@ Contains store credit history information. | 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. | +| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | #### Example @@ -5593,7 +5593,7 @@ Contains store credit history information. "action": "xyz789", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "xyz789" + "date_time_changed": "abc123" } ``` @@ -5607,12 +5607,12 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | +| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -5625,32 +5625,32 @@ An input object for updating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", "dob": "abc123", "firstname": "abc123", - "gender": 987, + "gender": 123, "is_subscribed": false, - "lastname": "abc123", - "middlename": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", "prefix": "abc123", "suffix": "xyz789", "taxvat": "xyz789" @@ -5667,12 +5667,12 @@ Contains information about a text area that is defined as part of a customizable | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example @@ -5680,11 +5680,11 @@ Contains information about a text area that is defined as part of a customizable ```json { "option_id": 123, - "product_sku": "abc123", - "required": false, + "product_sku": "xyz789", + "required": true, "sort_order": 987, - "title": "abc123", - "uid": "4", + "title": "xyz789", + "uid": 4, "value": CustomizableAreaValue } ``` @@ -5699,21 +5699,21 @@ Defines the price and sku of a product whose page contains a customized text are | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "max_characters": 123, + "max_characters": 987, "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" + "sku": "abc123", + "uid": 4 } ``` @@ -5727,22 +5727,22 @@ Contains information about a set of checkbox values that are defined as part of | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 987, "required": true, - "sort_order": 987, - "title": "abc123", - "uid": 4, + "sort_order": 123, + "title": "xyz789", + "uid": "4", "value": [CustomizableCheckboxValue] } ``` @@ -5757,25 +5757,25 @@ Defines the price and sku of a product whose page contains a customized set of c | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 987.65, "price_type": "FIXED", "sku": "abc123", "sort_order": 123, "title": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -5789,24 +5789,24 @@ Contains information about a date picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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", + "option_id": 123, + "product_sku": "abc123", "required": true, - "sort_order": 123, - "title": "abc123", - "uid": 4, + "sort_order": 987, + "title": "xyz789", + "uid": "4", "value": CustomizableDateValue } ``` @@ -5841,21 +5841,21 @@ Defines the price and sku of a product whose page contains a customized date pic | 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. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "xyz789", "type": "DATE", - "uid": "4" + "uid": 4 } ``` @@ -5869,22 +5869,22 @@ Contains information about a drop down menu that is defined as part of a customi | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 987, "required": true, "sort_order": 123, "title": "abc123", - "uid": 4, + "uid": "4", "value": [CustomizableDropDownValue] } ``` @@ -5899,24 +5899,24 @@ Defines the price and sku of a product whose page contains a customized drop dow | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "sort_order": 987, - "title": "xyz789", + "sort_order": 123, + "title": "abc123", "uid": "4" } ``` @@ -5931,21 +5931,21 @@ Contains information about a text field that is defined as part of a customizabl | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "option_id": 123, + "option_id": 987, "product_sku": "xyz789", - "required": false, + "required": true, "sort_order": 123, "title": "abc123", "uid": "4", @@ -5963,11 +5963,11 @@ Defines the price and sku of a product whose page contains a customized text fie | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example @@ -5976,8 +5976,8 @@ Defines the price and sku of a product whose page contains a customized text fie "max_characters": 987, "price": 987.65, "price_type": "FIXED", - "sku": "abc123", - "uid": 4 + "sku": "xyz789", + "uid": "4" } ``` @@ -5991,12 +5991,12 @@ Contains information about a file picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -6004,10 +6004,10 @@ Contains information about a file picker that is defined as part of a customizab ```json { "option_id": 123, - "product_sku": "xyz789", + "product_sku": "abc123", "required": true, - "sort_order": 987, - "title": "xyz789", + "sort_order": 123, + "title": "abc123", "uid": "4", "value": CustomizableFileValue } @@ -6023,25 +6023,25 @@ Defines the price and sku of a product whose page contains a customized file pic | 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. | +| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "file_extension": "abc123", + "file_extension": "xyz789", "image_size_x": 123, "image_size_y": 987, "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -6055,11 +6055,11 @@ Contains information about a multiselect that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example @@ -6067,8 +6067,8 @@ Contains information about a multiselect that is defined as part of a customizab ```json { "option_id": 987, - "required": true, - "sort_order": 123, + "required": false, + "sort_order": 987, "title": "xyz789", "uid": 4, "value": [CustomizableMultipleValue] @@ -6085,25 +6085,25 @@ Defines the price and sku of a product whose page contains a customized multisel | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { - "option_type_id": 987, - "price": 987.65, + "option_type_id": 123, + "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -6117,16 +6117,16 @@ Defines a customizable 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. | +| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | #### Example ```json { "id": 987, - "uid": "4", + "uid": 4, "value_string": "xyz789" } ``` @@ -6141,11 +6141,11 @@ Contains basic information about a customizable option. It can be implemented by | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -6167,7 +6167,7 @@ Contains basic information about a customizable option. It can be implemented by "option_id": 123, "required": false, "sort_order": 123, - "title": "abc123", + "title": "xyz789", "uid": 4 } ``` @@ -6188,12 +6188,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | | [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | #### Example @@ -6211,22 +6211,22 @@ Contains information about a set of radio buttons that are defined as part of a | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": "xyz789", - "uid": 4, + "option_id": 987, + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": "4", "value": [CustomizableRadioValue] } ``` @@ -6241,19 +6241,19 @@ Defines the price and sku of a product whose page contains a customized set of r | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 123.45, "price_type": "FIXED", "sku": "xyz789", @@ -6273,12 +6273,12 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -6291,12 +6291,12 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -6309,12 +6309,12 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -6327,7 +6327,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -6343,9 +6343,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -6364,14 +6364,14 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -6383,7 +6383,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -6402,7 +6402,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -6418,7 +6418,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example @@ -6436,9 +6436,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -6463,7 +6463,7 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example @@ -6484,7 +6484,7 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | +| `message` - [`String`](types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example @@ -6520,12 +6520,12 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example ```json -{"approval_rule_uids": [4]} +{"approval_rule_uids": ["4"]} ``` @@ -6556,7 +6556,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6574,13 +6574,13 @@ Indicates whether the request to delete the requisition list was successful. | 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. | +| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example ```json -{"requisition_lists": RequisitionLists, "status": true} +{"requisition_lists": RequisitionLists, "status": false} ``` @@ -6593,13 +6593,13 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"status": false, "wishlists": [Wishlist]} +{"status": true, "wishlists": [Wishlist]} ``` @@ -6612,13 +6612,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6627,10 +6627,10 @@ Specifies the discount type and value for quote line item. "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": false, + "is_discounting_locked": true, "label": "xyz789", - "type": "abc123", - "value": 987.65 + "type": "xyz789", + "value": 123.45 } ``` @@ -6644,22 +6644,22 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#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. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -6669,7 +6669,7 @@ An implementation for downloadable product cart items. "discount": [Discount], "errors": [CartItemError], "id": "xyz789", - "is_available": true, + "is_available": false, "links": [DownloadableProductLinks], "max_qty": 987.65, "min_qty": 987.65, @@ -6678,7 +6678,7 @@ An implementation for downloadable product cart items. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples], "uid": "4" } @@ -6696,12 +6696,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -6711,7 +6711,7 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "quantity_refunded": 123.45 @@ -6747,12 +6747,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6760,12 +6760,12 @@ Defines downloadable product options for `InvoiceItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -6779,17 +6779,17 @@ Defines characteristics of the links for downloadable product. | 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. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json { "sort_order": 987, - "title": "abc123", - "uid": "4" + "title": "xyz789", + "uid": 4 } ``` @@ -6805,27 +6805,27 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -6833,25 +6833,25 @@ Defines downloadable product options for `OrderItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "abc123", + "product_sku": "abc123", + "product_type": "xyz789", "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, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -6867,108 +6867,108 @@ Defines a product that the shopper downloads. | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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`](types-f-i.md#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", +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", + "category_gear": "xyz789", + "climate": "abc123", "collar": "xyz789", "color": 987, - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, @@ -6979,78 +6979,78 @@ Defines a product that the shopper downloads. "downloadable_product_samples": [ DownloadableProductSamples ], - "eco_collection": 987, + "eco_collection": 123, "erin_recommends": 987, - "features_bags": "xyz789", - "format": 123, - "gender": "xyz789", - "gift_message_available": true, - "gift_wrapping_available": true, + "features_bags": "abc123", + "format": 987, + "gender": "abc123", + "gift_message_available": false, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "id": 987, "image": ProductImage, - "is_returnable": "xyz789", - "links_purchased_separately": 123, - "links_title": "abc123", - "manufacturer": 987, + "is_returnable": "abc123", + "links_purchased_separately": 987, + "links_title": "xyz789", + "manufacturer": 123, "material": "abc123", - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "abc123", "min_sale_qty": 123.45, - "name": "xyz789", + "name": "abc123", "new": 123, "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "abc123", - "performance_fabric": 987, + "options_container": "xyz789", + "pattern": "xyz789", + "performance_fabric": 123, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 123, - "quantity": 123.45, + "quantity": 987.65, "rating_summary": 123.45, "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 987, + "sale": 123, "short_description": ComplexTextValue, "size": 123, - "sku": "xyz789", - "sleeve": "abc123", + "sku": "abc123", + "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "xyz789", + "special_price": 987.65, + "special_to_date": "abc123", "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", - "style_bags": "xyz789", + "strap_bags": "abc123", + "style_bags": "abc123", "style_bottom": "xyz789", - "style_general": "abc123", - "swatch_image": "abc123", + "style_general": "xyz789", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", "uid": 4, "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -7091,17 +7091,17 @@ Defines characteristics of a downloadable product. | 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.)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](types-a-b.md#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)* | +| `number_of_downloads` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example @@ -7112,12 +7112,12 @@ Defines characteristics of a downloadable product. "link_type": "FILE", "number_of_downloads": 123, "price": 987.65, - "sample_file": "xyz789", + "sample_file": "abc123", "sample_type": "FILE", - "sample_url": "abc123", - "sort_order": 123, + "sample_url": "xyz789", + "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -7131,12 +7131,12 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example ```json -{"link_id": 123} +{"link_id": 987} ``` @@ -7149,23 +7149,23 @@ Defines characteristics of a downloadable product. | 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)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | #### Example ```json { - "id": 123, + "id": 987, "sample_file": "abc123", "sample_type": "FILE", "sample_url": "xyz789", "sort_order": 123, - "title": "xyz789" + "title": "abc123" } ``` @@ -7179,12 +7179,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -7193,9 +7193,9 @@ Contains details about downloadable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "links": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -7209,13 +7209,13 @@ A downloadable product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example @@ -7224,7 +7224,7 @@ A downloadable product wish list item. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": 4, "links_v2": [DownloadableProductLinks], "product": ProductInterface, @@ -7243,16 +7243,13 @@ Identifies a quote to be duplicated | 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. | +| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | #### Example ```json -{ - "duplicated_quote_uid": 4, - "quote_uid": "4" -} +{"duplicated_quote_uid": 4, "quote_uid": 4} ``` @@ -7265,7 +7262,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -7284,15 +7281,12 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json -{ - "content": ComplexTextValue, - "uid": "4" -} +{"content": ComplexTextValue, "uid": 4} ``` @@ -7348,8 +7342,8 @@ Contains an array of dynamic blocks. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -7357,7 +7351,7 @@ Contains an array of dynamic blocks. { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -7371,14 +7365,18 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](types-f-i.md#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"} +{ + "dynamic_block_uids": ["4"], + "locations": ["CONTENT"], + "type": "SPECIFIED" +} ``` @@ -7391,8 +7389,8 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | +| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | #### Example @@ -7413,15 +7411,15 @@ Defines a customer-entered option. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | #### Example ```json { "uid": "4", - "value": "xyz789" + "value": "abc123" } ``` @@ -7435,12 +7433,12 @@ Contains the `uid`, `relative_url`, and `type` attributes. | 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. | +| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example @@ -7448,8 +7446,8 @@ Contains the `uid`, `relative_url`, and `type` attributes. { "canonical_url": "abc123", "entity_uid": 4, - "id": 123, - "redirectCode": 123, + "id": 987, + "redirectCode": 987, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -7466,21 +7464,21 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Possible Types | Error Types | |----------------| | [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](#insufficientstockerror) | +| [`InsufficientStockError`](types-f-i.md#insufficientstockerror) | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -7492,15 +7490,15 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | #### Example @@ -7519,7 +7517,7 @@ Contains details about an address. | 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. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -7527,7 +7525,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput } ``` @@ -7541,15 +7539,15 @@ Contains details about an address. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example ```json { "address": EstimateAddressInput, - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_method": ShippingMethodInput } ``` @@ -7582,13 +7580,13 @@ Lists the exchange rate. | 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. | +| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "abc123", "rate": 123.45} +{"currency_to": "xyz789", "rate": 123.45} ``` @@ -7601,7 +7599,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | #### 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 c0fd77a7d..3a9d1a359 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 @@ -8,15 +8,15 @@ Defines a filter that matches the input exactly. | 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"]`. | +| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"] + "in": ["abc123"] } ``` @@ -47,13 +47,13 @@ Defines a filter that performs a fuzzy search. | 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` - [`String`](types-q-s.md#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"} +{"match": "abc123", "match_type": "FULL"} ``` @@ -66,15 +66,15 @@ Defines a filter that matches a range of values, such as prices or dates. | 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. | +| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example ```json { "from": "abc123", - "to": "xyz789" + "to": "abc123" } ``` @@ -88,16 +88,16 @@ Defines a filter for an input string. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example ```json { - "eq": "xyz789", - "in": ["xyz789"], + "eq": "abc123", + "in": ["abc123"], "match": "xyz789" } ``` @@ -112,41 +112,41 @@ Defines the comparison operators that can be used in a filter. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](types-q-s.md#string) | | +| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](types-q-s.md#string) | Less than. | +| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](types-q-s.md#string) | Not null. | +| `null` - [`String`](types-q-s.md#string) | Is null. | +| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { - "eq": "xyz789", + "eq": "abc123", "finset": ["abc123"], "from": "abc123", "gt": "abc123", - "gteq": "abc123", - "in": ["abc123"], - "like": "xyz789", - "lt": "abc123", + "gteq": "xyz789", + "in": ["xyz789"], + "like": "abc123", + "lt": "xyz789", "lteq": "abc123", - "moreq": "abc123", - "neq": "abc123", + "moreq": "xyz789", + "neq": "xyz789", "nin": ["xyz789"], - "notnull": "abc123", + "notnull": "xyz789", "null": "abc123", - "to": "xyz789" + "to": "abc123" } ``` @@ -160,8 +160,8 @@ A single FPT that can be applied to a product price. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example @@ -218,12 +218,12 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example ```json -{"customer_email": "xyz789"} +{"customer_email": "abc123"} ``` @@ -236,7 +236,7 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | +| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | #### Example @@ -259,7 +259,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -277,7 +277,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": "4"} +{"negotiable_quote_uid": 4} ``` @@ -290,7 +290,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -308,9 +308,9 @@ Contains details about the gift card account. | 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. | +| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -332,7 +332,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | #### Example @@ -361,9 +361,9 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { - "attribute_id": 123, + "attribute_id": 987, "uid": 4, - "value": 123.45, + "value": 987.65, "value_id": 123, "website_id": 123, "website_value": 987.65 @@ -380,28 +380,28 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `amount` - [`Money!`](types-k-p.md#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 | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#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. | +| `message` - [`String`](types-q-s.md#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. | +| `not_available_message` - [`String`](types-q-s.md#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. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#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. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -415,21 +415,21 @@ Contains details about a gift card that has been added to a cart. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", + "id": "abc123", "is_available": false, "max_qty": 987.65, "message": "abc123", - "min_qty": 123.45, - "not_available_message": "abc123", + "min_qty": 987.65, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "recipient_email": "abc123", - "recipient_name": "abc123", - "sender_email": "abc123", - "sender_name": "abc123", + "quantity": 123.45, + "recipient_email": "xyz789", + "recipient_name": "xyz789", + "sender_email": "xyz789", + "sender_name": "xyz789", "uid": "4" } ``` @@ -442,13 +442,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -457,7 +457,7 @@ Contains details about a gift card that has been added to a cart. { "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, @@ -474,13 +474,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -508,21 +508,21 @@ Contains details about a gift card. | 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. | +| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](types-q-s.md#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" + "recipient_email": "xyz789", + "recipient_name": "abc123", + "sender_email": "abc123", + "sender_name": "abc123" } ``` @@ -536,13 +536,13 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -553,8 +553,8 @@ Contains details about the sender, recipient, and amount of a gift card. "message": "xyz789", "recipient_email": "xyz789", "recipient_name": "abc123", - "sender_email": "xyz789", - "sender_name": "abc123" + "sender_email": "abc123", + "sender_name": "xyz789" } ``` @@ -566,20 +566,20 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#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. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#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. | @@ -587,8 +587,8 @@ Contains details about the sender, recipient, and amount of a gift card. | `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. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -607,14 +607,14 @@ Contains details about the sender, recipient, and amount of a gift card. "product_sale_price": Money, "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 987.65, + "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, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "abc123" } @@ -630,100 +630,100 @@ Defines properties of a gift card. | 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. | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](types-a-b.md#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.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `features_bags` - [`String`](types-q-s.md#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. | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](types-q-s.md#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.)* | +| `material` - [`String`](types-q-s.md#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` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#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. | +| `name` - [`String`](types-q-s.md#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. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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.)* | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#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. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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 | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](types-c-e.md#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. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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 @@ -731,39 +731,39 @@ Defines properties of a gift card. ```json { "activity": "xyz789", - "allow_message": false, + "allow_message": true, "allow_open_amount": true, - "attribute_set_id": 123, + "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "abc123", + "category_gear": "xyz789", "climate": "abc123", - "collar": "abc123", + "collar": "xyz789", "color": 987, "country_of_manufacture": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "eco_collection": 123, + "eco_collection": 987, "erin_recommends": 987, "features_bags": "abc123", - "format": 987, - "gender": "abc123", + "format": 123, + "gender": "xyz789", "gift_card_options": [CustomizableOptionInterface], "gift_message_available": false, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", "id": 987, "image": ProductImage, "is_redeemable": false, - "is_returnable": "xyz789", + "is_returnable": "abc123", "lifetime": 123, "manufacturer": 123, "material": "abc123", - "max_sale_qty": 987.65, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "message_max_length": 987, @@ -771,58 +771,58 @@ Defines properties of a gift card. "meta_keyword": "xyz789", "meta_title": "abc123", "min_sale_qty": 123.45, - "name": "xyz789", - "new": 987, - "new_from_date": "abc123", + "name": "abc123", + "new": 123, + "new_from_date": "xyz789", "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "open_amount_max": 123.45, "open_amount_min": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "pattern": "xyz789", + "options_container": "abc123", + "pattern": "abc123", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 987, + "purpose": 123, "quantity": 123.45, - "rating_summary": 123.45, - "redirect_code": 987, + "rating_summary": 987.65, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "xyz789", + "relative_url": "abc123", "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, "size": 123, - "sku": "xyz789", - "sleeve": "xyz789", + "sku": "abc123", + "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": false, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", + "strap_bags": "abc123", "style_bags": "abc123", "style_bottom": "abc123", - "style_general": "xyz789", - "swatch_image": "xyz789", + "style_general": "abc123", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", + "type_id": "xyz789", "uid": 4, - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website], "weight": 123.45 } @@ -838,9 +838,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -866,10 +866,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -881,7 +881,7 @@ Contains details about gift cards added to a requisition list. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_shipped": 987.65 } ``` @@ -916,25 +916,25 @@ A single gift card added to a wish list. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "gift_card_options": GiftCardOptions, "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -948,17 +948,17 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | +| `from` - [`String!`](types-q-s.md#string) | Sender name | +| `message` - [`String!`](types-q-s.md#string) | Gift message text | +| `to` - [`String!`](types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "abc123", + "from": "xyz789", "message": "abc123", - "to": "xyz789" + "to": "abc123" } ``` @@ -972,15 +972,15 @@ Defines a gift message. | 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. | +| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | #### Example ```json { - "from": "xyz789", + "from": "abc123", "message": "xyz789", "to": "abc123" } @@ -996,12 +996,12 @@ Contains prices for gift wrapping options. | 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. | +| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](types-k-p.md#money) | Price for the printed card including tax. | #### Example @@ -1026,15 +1026,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `event_name` - [`String!`](types-q-s.md#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. | +| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](types-q-s.md#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. | +| `shipping_address` - [`CustomerAddress`](types-c-e.md#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. | @@ -1054,7 +1054,7 @@ Contains details about a gift registry. "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } ``` @@ -1068,16 +1068,16 @@ Contains details about a gift registry. |------------|-------------| | `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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": "4", + "code": 4, "group": "EVENT_INFORMATION", - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -1116,7 +1116,7 @@ Defines a dynamic attribute. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example @@ -1133,8 +1133,8 @@ Defines a dynamic attribute. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1161,23 +1161,23 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#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, + "attribute_group": "xyz789", + "code": "4", "input_type": "abc123", "is_required": false, "label": "abc123", - "sort_order": 123 + "sort_order": 987 } ``` @@ -1189,11 +1189,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1207,10 +1207,10 @@ Defines a dynamic attribute. ```json { "attribute_group": "abc123", - "code": 4, + "code": "4", "input_type": "abc123", - "is_required": true, - "label": "abc123", + "is_required": false, + "label": "xyz789", "sort_order": 987 } ``` @@ -1223,9 +1223,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1234,12 +1234,12 @@ Defines a dynamic attribute. ```json { - "created_at": "xyz789", + "created_at": "abc123", "note": "abc123", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 123.45, - "uid": "4" + "quantity_fulfilled": 987.65, + "uid": 4 } ``` @@ -1251,9 +1251,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1269,9 +1269,9 @@ Defines a dynamic attribute. ```json { "created_at": "xyz789", - "note": "abc123", + "note": "xyz789", "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "quantity_fulfilled": 987.65, "uid": 4 } @@ -1287,20 +1287,20 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](types-a-b.md#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) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example ```json { - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -1318,7 +1318,7 @@ Contains details about an error that occurred when processing a gift registry it | `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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1326,9 +1326,9 @@ Contains details about an error that occurred when processing a gift registry it ```json { "code": "OUT_OF_STOCK", - "gift_registry_item_uid": "4", + "gift_registry_item_uid": 4, "gift_registry_uid": 4, - "message": "xyz789", + "message": "abc123", "product_uid": "4" } ``` @@ -1369,7 +1369,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1407,9 +1407,9 @@ Contains details about a registrant. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1421,8 +1421,8 @@ Contains details about a registrant. ], "email": "xyz789", "firstname": "xyz789", - "lastname": "abc123", - "uid": "4" + "lastname": "xyz789", + "uid": 4 } ``` @@ -1435,14 +1435,14 @@ Contains details about a registrant. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": 4, + "code": "4", "label": "abc123", "value": "abc123" } @@ -1458,12 +1458,12 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | +| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](types-q-s.md#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. | +| `location` - [`String`](types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](types-q-s.md#string) | The type of event being held. | #### Example @@ -1472,7 +1472,7 @@ Contains the results of a gift registry search. "event_date": "xyz789", "event_title": "abc123", "gift_registry_uid": 4, - "location": "xyz789", + "location": "abc123", "name": "abc123", "type": "abc123" } @@ -1488,16 +1488,13 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](types-c-e.md#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" -} +{"address_data": CustomerAddressInput, "address_id": 4} ``` @@ -1530,7 +1527,7 @@ Contains details about a gift registry type. | 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. | +| `label` - [`String!`](types-q-s.md#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 @@ -1541,7 +1538,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -1555,10 +1552,10 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `design` - [`String!`](types-q-s.md#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. | +| `price` - [`Money!`](types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example @@ -1566,7 +1563,7 @@ Contains details about the selected or available gift wrapping options. ```json { "design": "abc123", - "id": 4, + "id": "4", "image": GiftWrappingImage, "price": Money, "uid": "4" @@ -1583,15 +1580,15 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | #### Example ```json { "label": "xyz789", - "url": "xyz789" + "url": "abc123" } ``` @@ -1603,15 +1600,15 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](#string) | The button color | +| `color` - [`String`](types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | +| `type` - [`String`](types-q-s.md#string) | The button type | #### Example ```json { - "color": "xyz789", + "color": "abc123", "height": 987, "type": "xyz789" } @@ -1626,28 +1623,28 @@ Points to an image associated with a gift wrapping option. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": GooglePayButtonStyles, - "code": "abc123", + "code": "xyz789", "is_visible": false, - "payment_intent": "xyz789", - "payment_source": "abc123", + "payment_intent": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "three_ds_mode": "OFF", - "title": "abc123" + "title": "xyz789" } ``` @@ -1661,16 +1658,16 @@ Google Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example ```json { - "payment_source": "xyz789", - "payments_order_id": "abc123", + "payment_source": "abc123", + "payments_order_id": "xyz789", "paypal_order_id": "abc123" } ``` @@ -1685,181 +1682,181 @@ Defines a grouped product, which consists of simple standalone products that are | Field Name | Description | |------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `activity` - [`String`](types-q-s.md#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.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `features_bags` - [`String`](types-q-s.md#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. | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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.)* | +| `material` - [`String`](types-q-s.md#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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#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. | +| `name` - [`String`](types-q-s.md#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. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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.)* | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#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. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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 | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](types-c-e.md#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. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#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.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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", + "activity": "abc123", "attribute_set_id": 123, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], "category_gear": "abc123", - "climate": "xyz789", - "collar": "xyz789", - "color": 123, + "climate": "abc123", + "collar": "abc123", + "color": 987, "country_of_manufacture": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "eco_collection": 987, "erin_recommends": 123, - "features_bags": "xyz789", - "format": 987, - "gender": "abc123", + "features_bags": "abc123", + "format": 123, + "gender": "xyz789", "gift_message_available": false, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 123, + "id": 987, "image": ProductImage, "is_returnable": "xyz789", "items": [GroupedProductItem], "manufacturer": 123, - "material": "xyz789", - "max_sale_qty": 123.45, + "material": "abc123", + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", "meta_title": "abc123", "min_sale_qty": 123.45, "name": "abc123", - "new": 123, - "new_from_date": "abc123", + "new": 987, + "new_from_date": "xyz789", "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, - "options_container": "abc123", + "options_container": "xyz789", "pattern": "xyz789", - "performance_fabric": 987, + "performance_fabric": 123, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 123, - "quantity": 123.45, + "quantity": 987.65, "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 123, "reviews": ProductReviews, "rules": [CatalogRule], "sale": 123, "short_description": ComplexTextValue, - "size": 123, - "sku": "xyz789", - "sleeve": "abc123", + "size": 987, + "sku": "abc123", + "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "abc123", "special_price": 987.65, - "special_to_date": "abc123", + "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "abc123", + "strap_bags": "xyz789", "style_bags": "abc123", - "style_bottom": "abc123", - "style_general": "xyz789", + "style_bottom": "xyz789", + "style_general": "abc123", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": 4, - "updated_at": "abc123", + "uid": "4", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", - "url_path": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -1874,16 +1871,16 @@ Contains information about an individual grouped product item. | 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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example ```json { - "position": 123, + "position": 987, "product": ProductInterface, - "qty": 987.65 + "qty": 123.45 } ``` @@ -1897,11 +1894,11 @@ A grouped product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -1910,7 +1907,7 @@ A grouped product wish list item. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": 4, "product": ProductInterface, "quantity": 123.45 @@ -1927,15 +1924,15 @@ Input to retrieve a guest order based on token. | Input Field | Description | |-------------|-------------| -| `reason` - [`String!`](#string) | Cancellation reason. | -| `token` - [`String!`](#string) | Order token. | +| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | +| `token` - [`String!`](types-q-s.md#string) | Order token. | #### Example ```json { "reason": "xyz789", - "token": "xyz789" + "token": "abc123" } ``` @@ -1947,18 +1944,18 @@ Input to retrieve a guest order based on token. | 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 | +| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](types-a-b.md#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -1968,12 +1965,12 @@ Input to retrieve a guest order based on token. "code": "xyz789", "is_vault_enabled": true, "is_visible": false, - "payment_intent": "xyz789", - "payment_source": "abc123", + "payment_intent": "abc123", + "payment_source": "xyz789", "requires_card_details": false, "sdk_params": [SDKParams], - "sort_order": "abc123", - "three_ds": false, + "sort_order": "xyz789", + "three_ds": true, "three_ds_mode": "OFF", "title": "xyz789" } @@ -1989,29 +1986,29 @@ Hosted Fields payment inputs | 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 | +| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example ```json { "cardBin": "abc123", - "cardExpiryMonth": "abc123", - "cardExpiryYear": "xyz789", + "cardExpiryMonth": "xyz789", + "cardExpiryYear": "abc123", "cardLast4": "abc123", "holderName": "xyz789", "is_active_payment_token_enabler": false, "payment_source": "xyz789", "payments_order_id": "abc123", - "paypal_order_id": "abc123" + "paypal_order_id": "xyz789" } ``` @@ -2025,15 +2022,15 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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" + "cancel_url": "abc123", + "return_url": "abc123" } ``` @@ -2047,12 +2044,12 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | #### Example ```json -{"secure_form_url": "abc123"} +{"secure_form_url": "xyz789"} ``` @@ -2065,7 +2062,7 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example @@ -2083,15 +2080,15 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | +| `name` - [`String`](types-q-s.md#string) | A parameter name. | +| `value` - [`String`](types-q-s.md#string) | A parameter value. | #### Example ```json { - "name": "xyz789", - "value": "xyz789" + "name": "abc123", + "value": "abc123" } ``` @@ -2119,8 +2116,8 @@ When expected as an input type, any string (such as `"4"`) or integer | 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. | +| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -2161,8 +2158,8 @@ List of templates/filters applied to customer attribute input. | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `code` - [`CartUserInputErrorType!`](types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `quantity` - [`Float`](#float) | Amount of available stock | #### Example @@ -2185,7 +2182,7 @@ values. Int can represent values between -(2^31) and 2^31 - 1. #### Example ```json -123 +987 ``` @@ -2198,7 +2195,7 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example @@ -2216,10 +2213,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#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. | +| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2229,7 +2226,7 @@ Contains invoice details. "comments": [SalesCommentItem], "id": 4, "items": [InvoiceItemInterface], - "number": "abc123", + "number": "xyz789", "total": InvoiceTotal } ``` @@ -2242,12 +2239,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2257,10 +2254,10 @@ Contains invoice details. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -2274,20 +2271,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`BundleInvoiceItem`](#bundleinvoiceitem) | -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2298,9 +2295,9 @@ Contains detailes about invoiced items. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 987.65 } ``` @@ -2315,14 +2312,14 @@ Contains price details from an invoice. | 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. | +| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2349,7 +2346,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2367,7 +2364,7 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example @@ -2385,7 +2382,7 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example @@ -2403,7 +2400,7 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example @@ -2421,12 +2418,12 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2439,18 +2436,18 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](types-q-s.md#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` - [`String`](types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example ```json { - "created_at": "abc123", + "created_at": "xyz789", "creator_id": 987, "creator_type": 987, "negotiable_quote_item_uid": "4", @@ -2470,7 +2467,7 @@ A list of options of the selected bundle product. | 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. | +| `label` - [`String!`](types-q-s.md#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. | @@ -2479,8 +2476,8 @@ A list of options of the selected bundle product. ```json { "id": "4", - "label": "abc123", - "uid": 4, + "label": "xyz789", + "uid": "4", "values": [ItemSelectedBundleOptionValue] } ``` @@ -2496,9 +2493,9 @@ A list of values for the selected bundle product. | 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. | +| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](types-q-s.md#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. | @@ -2508,10 +2505,10 @@ A list of values for the selected bundle product. { "id": 4, "price": Money, - "product_name": "xyz789", - "product_sku": "abc123", - "quantity": 123.45, - "uid": "4" + "product_name": "abc123", + "product_sku": "xyz789", + "quantity": 987.65, + "uid": 4 } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md index b5b73b13c..77d5c5177 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md @@ -8,15 +8,15 @@ Contains a key-value pair. | 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. | +| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | #### Example ```json { "name": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -31,16 +31,16 @@ Contains information for rendering layered navigation. | 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.)* | +| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | #### Example ```json { "filter_items": [LayerFilterItemInterface], - "filter_items_count": 987, + "filter_items_count": 123, "name": "abc123", "request_var": "xyz789" } @@ -54,17 +54,17 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#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" + "label": "abc123", + "value_string": "xyz789" } ``` @@ -76,16 +76,16 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#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) | +| [`SwatchLayerFilterItem`](types-q-s.md#swatchlayerfilteritem) | #### Example @@ -93,7 +93,7 @@ Contains information for rendering layered navigation. { "items_count": 987, "label": "xyz789", - "value_string": "xyz789" + "value_string": "abc123" } ``` @@ -107,17 +107,17 @@ Sets quote item note. | 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. | +| `note` - [`String`](types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "note": "abc123", - "quote_item_uid": 4, - "quote_uid": 4 + "note": "xyz789", + "quote_item_uid": "4", + "quote_uid": "4" } ``` @@ -132,14 +132,14 @@ Defines characteristics about images and videos associated with a specific produ | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -148,13 +148,13 @@ Defines characteristics about images and videos associated with a specific produ { "content": ProductMediaGalleryEntriesContent, "disabled": true, - "file": "xyz789", + "file": "abc123", "id": 123, - "label": "xyz789", - "media_type": "xyz789", - "position": 123, + "label": "abc123", + "media_type": "abc123", + "position": 987, "types": ["abc123"], - "uid": 4, + "uid": "4", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -169,10 +169,10 @@ Contains basic information about a product image or video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -186,8 +186,8 @@ Contains basic information about a product image or video. ```json { "disabled": false, - "label": "abc123", - "position": 987, + "label": "xyz789", + "position": 123, "url": "abc123" } ``` @@ -200,12 +200,12 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{"type": "abc123"} +{"type": "xyz789"} ``` @@ -216,7 +216,7 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `layout` - [`String`](#string) | The message layout | +| `layout` - [`String`](types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example @@ -238,8 +238,8 @@ Defines a monetary value, including a numeric value and a currency code. | 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. | +| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | #### Example @@ -257,9 +257,9 @@ Contains the customer's gift registry and any errors encountered. | 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. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -281,7 +281,7 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example @@ -299,8 +299,8 @@ Output of the request to move items to another requisition list. | 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. | +| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -321,16 +321,16 @@ Move Line Item to Requisition List. | 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. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json { "quote_item_uid": 4, - "quote_uid": 4, + "quote_uid": "4", "requisition_list_uid": "4" } ``` @@ -363,9 +363,9 @@ Contains the source and target wish lists after moving products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -387,23 +387,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](types-q-s.md#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. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#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. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -416,15 +416,15 @@ Contains details about a negotiable quote. "created_at": "abc123", "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", - "total_quantity": 987.65, - "uid": "4", + "total_quantity": 123.45, + "uid": 4, "updated_at": "xyz789" } ``` @@ -439,8 +439,8 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | +| `code` - [`String!`](types-q-s.md#string) | The address country code. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | #### Example @@ -461,17 +461,17 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example @@ -482,11 +482,11 @@ Defines the billing or shipping address to be applied to the cart. "country_code": "xyz789", "firstname": "xyz789", "lastname": "abc123", - "postcode": "abc123", - "region": "xyz789", + "postcode": "xyz789", + "region": "abc123", "region_id": 123, "save_in_address_book": true, - "street": ["abc123"], + "street": ["xyz789"], "telephone": "xyz789" } ``` @@ -499,15 +499,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -520,15 +520,15 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", - "lastname": "abc123", + "lastname": "xyz789", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["xyz789"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -542,9 +542,9 @@ Defines the company's state or province. | 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. | +| `code` - [`String`](types-q-s.md#string) | The address region code. | +| `label` - [`String`](types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -552,7 +552,7 @@ Defines the company's state or province. { "code": "abc123", "label": "abc123", - "region_id": 123 + "region_id": 987 } ``` @@ -564,29 +564,29 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "abc123", "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -601,9 +601,9 @@ Defines the billing address. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example @@ -611,8 +611,8 @@ Defines the billing address. { "address": NegotiableQuoteAddressInput, "customer_address_uid": "4", - "same_as_shipping": false, - "use_for_shipping": false + "same_as_shipping": true, + "use_for_shipping": true } ``` @@ -627,10 +627,10 @@ Contains a single plain text comment from either the buyer or seller. | 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. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example @@ -640,7 +640,7 @@ Contains a single plain text comment from either the buyer or seller. "created_at": "xyz789", "creator_type": "BUYER", "text": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -671,7 +671,7 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | +| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | #### Example @@ -689,17 +689,17 @@ Contains custom log entries added by third-party extensions. | 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. | +| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { - "new_value": "xyz789", - "old_value": "abc123", - "title": "xyz789" + "new_value": "abc123", + "old_value": "xyz789", + "title": "abc123" } ``` @@ -713,8 +713,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -765,7 +765,7 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example @@ -786,8 +786,8 @@ Contains details about a change for a negotiable quote. | `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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -830,15 +830,15 @@ Contains a new expiration date and the previous date. | 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. | +| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "new_expiration": "xyz789", - "old_expiration": "abc123" + "new_expiration": "abc123", + "old_expiration": "xyz789" } ``` @@ -852,14 +852,14 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#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_catalog": [4], "products_removed_from_quote": [ProductInterface] } ``` @@ -933,7 +933,7 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example @@ -951,8 +951,8 @@ Specifies the updated quantity of an item. | 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. | +| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example @@ -970,15 +970,15 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "code": "abc123", - "purchase_order_number": "abc123" + "code": "xyz789", + "purchase_order_number": "xyz789" } ``` @@ -992,18 +992,18 @@ Contains a reference document link for a negotiable quote template. | 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. | +| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID!`](types-f-i.md#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | #### Example ```json { "document_identifier": "abc123", - "document_name": "xyz789", - "link_id": "4", + "document_name": "abc123", + "link_id": 4, "reference_document_url": "xyz789" } ``` @@ -1016,17 +1016,17 @@ Contains a reference document link for a negotiable quote template. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `selected_shipping_method` - [`SelectedShippingMethod`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example @@ -1034,10 +1034,10 @@ Contains a reference document link for a negotiable quote template. { "available_shipping_methods": [AvailableShippingMethod], "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, @@ -1057,8 +1057,8 @@ Defines shipping addresses for the negotiable quote. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example @@ -1080,7 +1080,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1143,21 +1143,21 @@ Contains details about a negotiable quote template. |------------|-------------| | `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. | +| `expiration_date` - [`String!`](types-q-s.md#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. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](types-c-e.md#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. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | #### Example @@ -1167,21 +1167,21 @@ Contains details about a negotiable quote template. "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, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "xyz789", + "status": "abc123", "template_id": "4", - "total_quantity": 123.45 + "total_quantity": 987.65 } ``` @@ -1195,8 +1195,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1217,39 +1217,39 @@ Contains data for a negotiable quote template in a grid. | 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. | +| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "activated_at": "abc123", + "activated_at": "xyz789", "company_name": "abc123", "expiration_date": "xyz789", "is_min_max_qty_used": true, - "last_shared_at": "xyz789", + "last_shared_at": "abc123", "max_order_commitment": 987, - "min_negotiated_grand_total": 987.65, + "min_negotiated_grand_total": 123.45, "min_order_commitment": 987, "name": "abc123", "orders_placed": 123, - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "state": "xyz789", - "status": "abc123", + "status": "xyz789", "submitted_by": "abc123", "template_id": "4" } @@ -1265,15 +1265,15 @@ Specifies the updated quantity of an 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. | +| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | #### Example ```json -{"item_id": 4, "max_qty": 123.45, "min_qty": 987.65, "quantity": 987.65} +{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65} ``` @@ -1286,10 +1286,10 @@ Defines the reference document link to add to a negotiable quote template. | 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. | +| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | #### Example @@ -1297,7 +1297,7 @@ Defines the reference document link to add to a negotiable quote template. { "document_identifier": "abc123", "document_name": "xyz789", - "link_id": 4, + "link_id": "4", "reference_document_url": "abc123" } ``` @@ -1313,16 +1313,16 @@ Defines shipping addresses for the negotiable quote template. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "customer_notes": "xyz789" + "customer_address_uid": 4, + "customer_notes": "abc123" } ``` @@ -1336,7 +1336,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1373,9 +1373,9 @@ Contains a list of negotiable templates that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1396,7 +1396,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1407,7 +1407,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -1420,12 +1420,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -1438,14 +1438,14 @@ A limited view of a Buyer or Seller in the negotiable quote process. | 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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | #### Example ```json { - "firstname": "xyz789", + "firstname": "abc123", "lastname": "xyz789" } ``` @@ -1461,9 +1461,9 @@ Contains a list of negotiable that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1472,7 +1472,7 @@ Contains a list of negotiable that match the specified filter. "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } ``` @@ -1486,14 +1486,14 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "uid": "4" } ``` @@ -1508,12 +1508,12 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -1526,14 +1526,14 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json { - "order_id": "xyz789", + "order_id": "abc123", "order_number": "xyz789" } ``` @@ -1568,43 +1568,43 @@ Contains detailed information about an order's billing and shipping addresses. | 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). | +| `city` - [`String!`](types-q-s.md#string) | The city or town. | +| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "fax": "abc123", "firstname": "abc123", - "lastname": "abc123", - "middlename": "abc123", - "postcode": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", "prefix": "abc123", - "region": "xyz789", - "region_id": 4, + "region": "abc123", + "region_id": "4", "street": ["abc123"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "abc123", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -1616,11 +1616,11 @@ Contains detailed information about an order's billing and shipping addresses. | 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 | +| `firstname` - [`String!`](types-q-s.md#string) | First name of the customer | +| `lastname` - [`String`](types-q-s.md#string) | Last name of the customer | +| `middlename` - [`String`](types-q-s.md#string) | Middle name of the customer | +| `prefix` - [`String`](types-q-s.md#string) | Prefix of the customer | +| `suffix` - [`String`](types-q-s.md#string) | Suffix of the customer | #### Example @@ -1630,7 +1630,7 @@ Contains detailed information about an order's billing and shipping addresses. "lastname": "abc123", "middlename": "xyz789", "prefix": "abc123", - "suffix": "abc123" + "suffix": "xyz789" } ``` @@ -1644,16 +1644,16 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `lastname` - [`String!`](#string) | Order billing address lastname. | -| `number` - [`String!`](#string) | Order number. | +| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | +| `lastname` - [`String!`](types-q-s.md#string) | Order billing address lastname. | +| `number` - [`String!`](types-q-s.md#string) | Order number. | #### Example ```json { - "email": "xyz789", - "lastname": "xyz789", + "email": "abc123", + "lastname": "abc123", "number": "abc123" } ``` @@ -1666,28 +1666,28 @@ Input to retrieve an order based on details. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -1698,23 +1698,23 @@ Input to retrieve an order based on details. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "xyz789", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, + "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": 123.45, - "quantity_shipped": 123.45, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -1728,37 +1728,37 @@ Order item details. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`ConfigurableOrderItem`](#configurableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`ConfigurableOrderItem`](types-c-e.md#configurableorderitem) | +| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | +| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | +| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1778,15 +1778,15 @@ Order item details. "product_sku": "xyz789", "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, + "quantity_refunded": 123.45, + "quantity_return_requested": 123.45, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -1800,15 +1800,15 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | +| `label` - [`String!`](types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -1820,8 +1820,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](types-f-i.md#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. | @@ -1861,16 +1861,16 @@ Contains details about the payment method used to pay for the order. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example ```json { "additional_data": [KeyValue], - "name": "abc123", - "type": "xyz789" + "name": "xyz789", + "type": "abc123" } ``` @@ -1884,11 +1884,11 @@ Contains order shipment details. | 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. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example @@ -1897,7 +1897,7 @@ Contains order shipment details. "comments": [SalesCommentItem], "id": "4", "items": [ShipmentItemInterface], - "number": "abc123", + "number": "xyz789", "tracking": [ShipmentTracking] } ``` @@ -1912,7 +1912,7 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](#string) | Order token. | +| `token` - [`String!`](types-q-s.md#string) | Order token. | #### Example @@ -1931,14 +1931,14 @@ Contains details about the sales total amounts used to calculate the final price | 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) | | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#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. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#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. | @@ -1976,8 +1976,8 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example @@ -1998,9 +1998,9 @@ A set of relative URLs that PayPal uses in response to various actions during th | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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 @@ -2008,7 +2008,7 @@ A set of relative URLs that PayPal uses in response to various actions during th { "cancel_url": "xyz789", "error_url": "xyz789", - "return_url": "abc123" + "return_url": "xyz789" } ``` @@ -2042,9 +2042,9 @@ Contains information used to generate PayPal iframe for transaction. Applies to | 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. | +| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example @@ -2052,8 +2052,8 @@ Contains information used to generate PayPal iframe for transaction. Applies to { "mode": "TEST", "paypal_url": "abc123", - "secure_token": "abc123", - "secure_token_id": "abc123" + "secure_token": "xyz789", + "secure_token_id": "xyz789" } ``` @@ -2067,7 +2067,7 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -2085,8 +2085,8 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | 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. | +| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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 @@ -2107,15 +2107,15 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | #### Example ```json { - "cart_id": "abc123", - "paypal_payload": "xyz789" + "cart_id": "xyz789", + "paypal_payload": "abc123" } ``` @@ -2127,7 +2127,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -2145,7 +2145,7 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | | `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example @@ -2167,9 +2167,9 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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 @@ -2177,7 +2177,7 @@ Contains a set of relative URLs that PayPal uses in response to various actions { "cancel_url": "xyz789", "error_url": "abc123", - "return_url": "xyz789" + "return_url": "abc123" } ``` @@ -2191,32 +2191,32 @@ Contains payment fields that are common to all types of payment methods. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | -| [`ApplePayConfig`](#applepayconfig) | -| [`GooglePayConfig`](#googlepayconfig) | +| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | +| [`ApplePayConfig`](types-a-b.md#applepayconfig) | +| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | #### Example ```json { - "code": "abc123", + "code": "xyz789", "is_visible": false, "payment_intent": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "abc123" + "sort_order": "abc123", + "title": "xyz789" } ``` @@ -2230,10 +2230,10 @@ Retrieves the payment configuration for a given location | 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 | +| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2278,27 +2278,27 @@ Defines the payment method. | 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. | +| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](types-f-i.md#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 | +| `payflowpro_cc_vault` - [`VaultTokenInput`](types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#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. | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -2312,7 +2312,7 @@ Defines the payment method. "braintree_googlepay_vault": BraintreeVaultInput, "braintree_paypal": BraintreeInput, "braintree_paypal_vault": BraintreeVaultInput, - "code": "abc123", + "code": "xyz789", "hosted_pro": HostedProInput, "payflow_express": PayflowExpressInput, "payflow_link": PayflowLinkInput, @@ -2324,7 +2324,7 @@ Defines the payment method. "payment_services_paypal_smart_buttons": SmartButtonMethodInput, "payment_services_paypal_vault": VaultMethodInput, "paypal_express": PaypalExpressInput, - "purchase_order_number": "abc123" + "purchase_order_number": "xyz789" } ``` @@ -2338,17 +2338,17 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#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 | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example ```json { - "id": "xyz789", - "mp_order_id": "xyz789", + "id": "abc123", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, "status": "abc123" } @@ -2362,8 +2362,8 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | +| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | #### Example @@ -2382,7 +2382,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | +| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2400,7 +2400,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | +| `card` - [`CardPaymentSourceInput!`](types-c-e.md#cardpaymentsourceinput) | The card payment source information | #### Example @@ -2418,7 +2418,7 @@ The payment source information | Field Name | Description | |------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | +| `card` - [`CardPaymentSourceOutput!`](types-c-e.md#cardpaymentsourceoutput) | The card payment source information | #### Example @@ -2436,18 +2436,18 @@ The stored payment method available to the customer. | 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. | +| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "details": "abc123", + "details": "xyz789", "payment_method_code": "xyz789", - "public_hash": "abc123", + "public_hash": "xyz789", "type": "card" } ``` @@ -2481,8 +2481,8 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example @@ -2503,21 +2503,21 @@ Defines the attributes required to receive a payment token for Express Checkout | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](types-a-b.md#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. | +| `use_paypal_credit` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "code": "abc123", "express_button": false, "urls": PaypalExpressUrlsInput, - "use_paypal_credit": true + "use_paypal_credit": false } ``` @@ -2532,7 +2532,7 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | 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. | +| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | #### Example @@ -2553,15 +2553,15 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | 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. | +| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | #### Example ```json { - "edit": "abc123", - "start": "abc123" + "edit": "xyz789", + "start": "xyz789" } ``` @@ -2575,19 +2575,19 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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": "abc123", - "success_url": "abc123" + "pending_url": "abc123", + "return_url": "xyz789", + "success_url": "xyz789" } ``` @@ -2601,22 +2601,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](types-f-i.md#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) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | #### Example ```json -{"weight": 123.45} +{"weight": 987.65} ``` @@ -2629,41 +2629,41 @@ Defines Pickup Location information. | 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) | | +| `city` - [`String`](types-q-s.md#string) | | +| `contact_name` - [`String`](types-q-s.md#string) | | +| `country_id` - [`String`](types-q-s.md#string) | | +| `description` - [`String`](types-q-s.md#string) | | +| `email` - [`String`](types-q-s.md#string) | | +| `fax` - [`String`](types-q-s.md#string) | | +| `latitude` - [`Float`](types-f-i.md#float) | | +| `longitude` - [`Float`](types-f-i.md#float) | | +| `name` - [`String`](types-q-s.md#string) | | +| `phone` - [`String`](types-q-s.md#string) | | +| `pickup_location_code` - [`String`](types-q-s.md#string) | | +| `postcode` - [`String`](types-q-s.md#string) | | +| `region` - [`String`](types-q-s.md#string) | | +| `region_id` - [`Int`](types-f-i.md#int) | | +| `street` - [`String`](types-q-s.md#string) | | #### Example ```json { "city": "xyz789", - "contact_name": "abc123", + "contact_name": "xyz789", "country_id": "xyz789", - "description": "abc123", + "description": "xyz789", "email": "abc123", - "fax": "xyz789", + "fax": "abc123", "latitude": 123.45, - "longitude": 987.65, - "name": "xyz789", + "longitude": 123.45, + "name": "abc123", "phone": "xyz789", "pickup_location_code": "abc123", "postcode": "xyz789", "region": "abc123", - "region_id": 123, - "street": "xyz789" + "region_id": 987, + "street": "abc123" } ``` @@ -2677,14 +2677,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | 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. | +| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2711,22 +2711,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | 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. | +| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2762,8 +2762,8 @@ Top level object returned in a pickup locations search. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | #### Example @@ -2785,12 +2785,12 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -2822,14 +2822,14 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "CART_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -2863,12 +2863,12 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json -{"purchase_order_uid": 4} +{"purchase_order_uid": "4"} ``` @@ -2881,7 +2881,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | #### Example @@ -2899,7 +2899,7 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2919,7 +2919,7 @@ Contains the results of the request to place an order. |------------|-------------| | `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. | +| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | #### Example @@ -2941,12 +2941,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -3062,9 +3062,9 @@ Can be used to retrieve the main price details in case of bundle product | 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 | +| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | #### Example @@ -3147,8 +3147,8 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | +| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | #### Example @@ -3169,37 +3169,37 @@ Defines the filters to be used in the search. A filter contains at least one att | 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 | +| `activity` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Activity | +| `category_gear` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Category Gear | +| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | +| `climate` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Climate | +| `collar` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Collar | +| `color` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Color | +| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `eco_collection` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Eco Collection | +| `erin_recommends` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Erin Recommends | +| `features_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Features | +| `format` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Format | +| `gender` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Gender | +| `material` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Material | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `new` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: New | +| `pattern` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Pattern | +| `performance_fabric` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Performance Fabric | +| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `purpose` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Purpose | +| `sale` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sale | +| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `size` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Size | +| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `sleeve` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sleeve | +| `strap_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Strap/Handle | +| `style_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bags | +| `style_bottom` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bottom | +| `style_general` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style General | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -3249,10 +3249,10 @@ Specifies the attribute to use for sorting search results and indicates whether | 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). | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -3270,8 +3270,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3292,13 +3292,13 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | #### Example ```json -{"amount_off": 987.65, "percent_off": 987.65} +{"amount_off": 987.65, "percent_off": 123.45} ``` @@ -3311,45 +3311,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | 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. | +| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](types-f-i.md#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. | +| `price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -3407,19 +3407,19 @@ Contains product image information, including the image URL and label. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { - "disabled": false, - "label": "xyz789", - "position": 987, - "url": "xyz789" + "disabled": true, + "label": "abc123", + "position": 123, + "url": "abc123" } ``` @@ -3450,7 +3450,7 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | +| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | #### Example @@ -3468,182 +3468,182 @@ Contains fields that are common to all types of products. | 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.)* | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#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. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#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`](types-f-i.md#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 | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#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.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#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_tiers` - [`[TierPrice]`](types-t-z.md#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. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#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. | +| `review_count` - [`Int!`](types-f-i.md#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.)* | +| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#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. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#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. | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#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_price` - [`Float`](types-f-i.md#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.)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#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.)* | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | #### Example ```json { "activity": "abc123", - "attribute_set_id": 123, + "attribute_set_id": 987, "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "xyz789", "climate": "abc123", "collar": "xyz789", - "color": 987, - "country_of_manufacture": "abc123", - "created_at": "xyz789", + "color": 123, + "country_of_manufacture": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "eco_collection": 987, + "eco_collection": 123, "erin_recommends": 987, "features_bags": "xyz789", "format": 987, - "gender": "xyz789", - "gift_message_available": false, - "gift_wrapping_available": true, + "gender": "abc123", + "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": 123.45, + "material": "xyz789", + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, "name": "xyz789", "new": 987, "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, - "options_container": "xyz789", - "pattern": "abc123", - "performance_fabric": 123, + "options_container": "abc123", + "pattern": "xyz789", + "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 987, - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 987.65, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], "sale": 123, "short_description": ComplexTextValue, "size": 987, - "sku": "abc123", - "sleeve": "abc123", + "sku": "xyz789", + "sleeve": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "abc123", + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", - "style_bags": "abc123", + "strap_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "abc123", - "style_general": "abc123", - "swatch_image": "xyz789", + "style_general": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], - "type_id": "xyz789", - "uid": "4", - "updated_at": "abc123", + "type_id": "abc123", + "uid": 4, + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -3658,11 +3658,11 @@ An implementation of `ProductLinksInterface`. | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Example @@ -3672,7 +3672,7 @@ An implementation of `ProductLinksInterface`. "linked_product_sku": "abc123", "linked_product_type": "xyz789", "position": 987, - "sku": "xyz789" + "sku": "abc123" } ``` @@ -3686,11 +3686,11 @@ Contains information about linked products, including the link type and product | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3702,11 +3702,11 @@ Contains information about linked products, including the link type and product ```json { - "link_type": "xyz789", + "link_type": "abc123", "linked_product_sku": "xyz789", - "linked_product_type": "abc123", - "position": 123, - "sku": "abc123" + "linked_product_type": "xyz789", + "position": 987, + "sku": "xyz789" } ``` @@ -3720,15 +3720,15 @@ Contains an image in base64 format and basic information about the image. | 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. | +| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "base64_encoded_data": "abc123", + "base64_encoded_data": "xyz789", "name": "xyz789", "type": "abc123" } @@ -3744,22 +3744,22 @@ Contains a link to a video file and basic information about the video. | 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. | +| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | #### Example ```json { "media_type": "abc123", - "video_description": "xyz789", - "video_metadata": "xyz789", - "video_provider": "abc123", - "video_title": "abc123", + "video_description": "abc123", + "video_metadata": "abc123", + "video_provider": "xyz789", + "video_title": "xyz789", "video_url": "xyz789" } ``` @@ -3776,7 +3776,7 @@ Represents a product price. |------------|-------------| | `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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#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 @@ -3824,13 +3824,13 @@ Contains details of a product review. | 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. | +| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](types-q-s.md#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. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example @@ -3838,10 +3838,10 @@ Contains details of a product review. { "average_rating": 123.45, "created_at": "abc123", - "nickname": "abc123", + "nickname": "xyz789", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], - "summary": "abc123", + "summary": "xyz789", "text": "abc123" } ``` @@ -3856,8 +3856,8 @@ Contains data about a single aspect of a product review. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example @@ -3878,8 +3878,8 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example @@ -3900,8 +3900,8 @@ Contains details about a single aspect of a product review. | 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. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](types-q-s.md#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 @@ -3909,7 +3909,7 @@ Contains details about a single aspect of a product review. ```json { "id": "abc123", - "name": "abc123", + "name": "xyz789", "values": [ProductReviewRatingValueMetadata] } ``` @@ -3924,8 +3924,8 @@ Contains details about a single value in a product review. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example @@ -3965,7 +3965,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -4005,11 +4005,11 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | 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.)* | +| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example @@ -4017,7 +4017,7 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d { "customer_group_id": "xyz789", "percentage_value": 123.45, - "qty": 987.65, + "qty": 123.45, "value": 987.65, "website_id": 987.65 } @@ -4033,10 +4033,10 @@ Contains information about a product video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example @@ -4045,8 +4045,8 @@ Contains information about a product video. { "disabled": true, "label": "abc123", - "position": 123, - "url": "xyz789", + "position": 987, + "url": "abc123", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -4061,13 +4061,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](types-a-b.md#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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -4096,15 +4096,15 @@ Contains details about a purchase order. | `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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](types-c-e.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -4113,7 +4113,7 @@ Contains details about a purchase order. "approval_flow": [PurchaseOrderRuleApprovalFlow], "available_actions": ["REJECT"], "comments": [PurchaseOrderComment], - "created_at": "abc123", + "created_at": "xyz789", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], "number": "abc123", @@ -4121,7 +4121,7 @@ Contains details about a purchase order. "quote": Cart, "status": "PENDING", "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -4155,7 +4155,7 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example @@ -4174,11 +4174,11 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | +| `message` - [`String`](types-q-s.md#string) | A formatted message. | +| `name` - [`String`](types-q-s.md#string) | The approver name. | +| `role` - [`String`](types-q-s.md#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. | +| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | #### Example @@ -4186,7 +4186,7 @@ Contains details about a single event in the approval flow of the purchase order { "message": "xyz789", "name": "abc123", - "role": "abc123", + "role": "xyz789", "status": "PENDING", "updated_at": "abc123" } @@ -4220,16 +4220,16 @@ Contains details about a purchase order approval rule. | 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. | +| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -4239,11 +4239,11 @@ Contains details about a purchase order approval rule. "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", - "created_by": "abc123", + "created_by": "xyz789", "description": "abc123", "name": "abc123", "status": "ENABLED", - "uid": "4", + "uid": 4, "updated_at": "abc123" } ``` @@ -4329,7 +4329,7 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example @@ -4347,22 +4347,22 @@ Defines a new purchase order approval rule. | 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. | +| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "applies_to": [4], + "applies_to": ["4"], "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", - "name": "xyz789", + "description": "abc123", + "name": "abc123", "status": "ENABLED" } ``` @@ -4377,9 +4377,9 @@ Contains metadata that can be used to render rule edit forms. | 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. | +| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4437,8 +4437,8 @@ Contains the approval rules that the customer can see. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4460,10 +4460,10 @@ Contains details about a comment. | 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. | +| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | #### Example @@ -4506,16 +4506,16 @@ Contains details about a status change. | 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. | +| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "activity": "xyz789", + "activity": "abc123", "created_at": "abc123", "message": "xyz789", "uid": 4 @@ -4533,14 +4533,14 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | +| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | #### Example ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "xyz789" + "rule_name": "abc123" } ``` @@ -4579,8 +4579,8 @@ Contains a list of purchase orders. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4588,7 +4588,7 @@ Contains a list of purchase orders. { "items": [PurchaseOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -4602,12 +4602,12 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -4642,18 +4642,18 @@ Defines the criteria to use to filter the list of purchase orders. | 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. | +| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](types-a-b.md#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, + "company_purchase_orders": false, "created_date": FilterRangeTypeInput, - "require_my_approval": true, + "require_my_approval": false, "status": "PENDING" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md index a6635af25..7a1a95871 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md @@ -27,17 +27,17 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `item_id` - [`ID!`](types-f-i.md#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. | +| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "item_id": 4, + "item_id": "4", "note": "xyz789", - "templateId": "4" + "templateId": 4 } ``` @@ -58,8 +58,8 @@ Contains a notification message for a negotiable quote template. ```json { - "message": "xyz789", - "type": "xyz789" + "message": "abc123", + "type": "abc123" } ``` @@ -72,7 +72,7 @@ Contains a notification message for a negotiable quote template. | Field Name | Description | |------------|-------------| | `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | +| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | #### Example @@ -95,7 +95,7 @@ Contains reCAPTCHA form configuration details. |------------|-------------| | `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. | +| `minimum_score` - [`Float`](types-f-i.md#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. | @@ -111,9 +111,9 @@ Contains reCAPTCHA form configuration details. "minimum_score": 123.45, "re_captcha_type": "INVISIBLE", "technical_failure_message": "xyz789", - "theme": "xyz789", - "validation_failure_message": "xyz789", - "website_key": "abc123" + "theme": "abc123", + "validation_failure_message": "abc123", + "website_key": "xyz789" } ``` @@ -130,9 +130,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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 | +| `is_enabled` - [`Boolean!`](types-a-b.md#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. | +| `minimum_score` - [`Float!`](types-f-i.md#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. | @@ -140,13 +140,13 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { - "badge_position": "xyz789", + "badge_position": "abc123", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "xyz789", - "minimum_score": 123.45, - "theme": "xyz789", + "is_enabled": false, + "language_code": "abc123", + "minimum_score": 987.65, + "theme": "abc123", "website_key": "xyz789" } ``` @@ -204,15 +204,15 @@ Contains reCAPTCHA V3-Invisible configuration details. | 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. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example ```json { - "code": "xyz789", - "id": 123, + "code": "abc123", + "id": 987, "name": "abc123" } ``` @@ -245,7 +245,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -292,7 +292,7 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "gift_card_code": "abc123" } ``` @@ -307,7 +307,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -325,7 +325,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -343,12 +343,12 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -361,7 +361,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -380,16 +380,16 @@ Specifies which items to remove from the cart. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { "cart_id": "abc123", - "cart_item_id": 987, - "cart_item_uid": 4 + "cart_item_id": 123, + "cart_item_uid": "4" } ``` @@ -403,7 +403,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -421,13 +421,16 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_item_uids": ["4"], "quote_uid": 4} +{ + "quote_item_uids": ["4"], + "quote_uid": "4" +} ``` @@ -440,7 +443,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -458,8 +461,8 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -477,13 +480,16 @@ Defines which products to remove from a compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": ["4"], "uid": 4} +{ + "products": ["4"], + "uid": "4" +} ``` @@ -496,8 +502,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -518,7 +524,7 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example @@ -554,7 +560,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -590,7 +596,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -610,7 +616,7 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example @@ -618,7 +624,7 @@ Sets new name for a negotiable quote. { "quote_comment": "abc123", "quote_name": "abc123", - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -632,7 +638,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -650,8 +656,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -684,7 +690,7 @@ Contains information needed to start a return request. "comment_text": "abc123", "contact_email": "abc123", "items": [RequestReturnItemInput], - "token": "xyz789" + "token": "abc123" } ``` @@ -698,9 +704,9 @@ Defines properties of a negotiable quote request. | 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. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](types-a-b.md#boolean) | Flag indicating if quote is draft or not. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -709,8 +715,8 @@ Defines properties of a negotiable quote request. { "cart_id": "4", "comment": NegotiableQuoteCommentInput, - "is_draft": true, - "quote_name": "xyz789" + "is_draft": false, + "quote_name": "abc123" } ``` @@ -724,7 +730,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -742,12 +748,12 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example ```json -{"cart_id": 4} +{"cart_id": "4"} ``` @@ -763,16 +769,16 @@ Contains information needed to start a return request. | `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. | +| `order_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { "comment_text": "xyz789", - "contact_email": "xyz789", + "contact_email": "abc123", "items": [RequestReturnItemInput], - "order_uid": "4" + "order_uid": 4 } ``` @@ -786,9 +792,9 @@ Contains details about an item to be returned. | 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. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](types-f-i.md#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 @@ -799,7 +805,7 @@ Contains details about an item to be returned. EnteredCustomAttributeInput ], "order_item_uid": "4", - "quantity_to_return": 987.65, + "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -840,9 +846,9 @@ Defines the contents of a requisition list. |------------|-------------| | `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. | +| `items_count` - [`Int!`](types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example @@ -851,8 +857,8 @@ Defines the contents of a requisition list. { "description": "abc123", "items": RequistionListItems, - "items_count": 987, - "name": "abc123", + "items_count": 123, + "name": "xyz789", "uid": "4", "updated_at": "abc123" } @@ -868,8 +874,8 @@ Defines requisition list filters. | 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. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -891,20 +897,20 @@ The interface for requisition list items. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#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) | +| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -927,9 +933,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#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. | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -939,9 +945,9 @@ Defines the items to add. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 987.65, - "selected_options": ["xyz789"], - "sku": "xyz789" + "quantity": 123.45, + "selected_options": ["abc123"], + "sku": "abc123" } ``` @@ -957,7 +963,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -965,7 +971,7 @@ Defines customer requisition lists. { "items": [RequisitionList], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -981,7 +987,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `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. | +| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | #### Example @@ -989,7 +995,7 @@ Contains an array of items added to a requisition list. { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 987 + "total_pages": 123 } ``` @@ -1009,10 +1015,10 @@ Contains details about a return. | `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. | +| `order` - [`CustomerOrder`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -1020,14 +1026,14 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "abc123", + "created_at": "xyz789", "customer": ReturnCustomer, "items": [ReturnItem], "number": "xyz789", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -1044,16 +1050,16 @@ Contains details about a return comment. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example ```json { - "author_name": "abc123", + "author_name": "xyz789", "created_at": "xyz789", "text": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -1068,7 +1074,7 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example @@ -1100,8 +1106,8 @@ The customer information for the return. ```json { "email": "xyz789", - "firstname": "xyz789", - "lastname": "abc123" + "firstname": "abc123", + "lastname": "xyz789" } ``` @@ -1116,12 +1122,12 @@ Contains details about a product being returned. | 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. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1131,7 +1137,7 @@ Contains details about a product being returned. "custom_attributesV2": [AttributeValueInterface], "order_item": OrderItemInterface, "quantity": 987.65, - "request_quantity": 987.65, + "request_quantity": 123.45, "status": "PENDING", "uid": 4 } @@ -1147,36 +1153,36 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](types-f-i.md#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. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#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. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#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. | +| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": 4, - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", "is_required": false, - "is_unique": false, + "is_unique": true, "label": "xyz789", "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -1236,7 +1242,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `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. | +| `country` - [`Country!`](types-c-e.md#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. | @@ -1249,10 +1255,10 @@ Contains details about the shipping address used for receiving returned items. "city": "abc123", "contact_name": "xyz789", "country": Country, - "postcode": "xyz789", + "postcode": "abc123", "region": Region, "street": ["xyz789"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1267,7 +1273,7 @@ Contains details about the carrier on a return. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example @@ -1291,7 +1297,7 @@ Contains shipping and tracking details. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1299,7 +1305,7 @@ Contains shipping and tracking details. { "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, - "tracking_number": "abc123", + "tracking_number": "xyz789", "uid": 4 } ``` @@ -1320,7 +1326,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "xyz789", "type": "INFORMATION"} +{"text": "abc123", "type": "INFORMATION"} ``` @@ -1380,7 +1386,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | #### Example @@ -1388,7 +1394,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1402,7 +1408,7 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example @@ -1444,13 +1450,13 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | #### Example ```json -{"money": Money, "points": 123.45} +{"money": Money, "points": 987.65} ``` @@ -1466,7 +1472,7 @@ Contain details about the reward points transaction. | `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. | +| `points_change` - [`Float!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example @@ -1475,7 +1481,7 @@ Contain details about the reward points transaction. "balance": RewardPointsAmount, "change_reason": "xyz789", "date": "abc123", - "points_change": 123.45 + "points_change": 987.65 } ``` @@ -1511,8 +1517,8 @@ Contains details about customer's reward points rate. | 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. | +| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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 @@ -1569,30 +1575,30 @@ Routable entities serve as the model for a rendered page. | 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. | +| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | +| [`CmsPage`](types-c-e.md#cmspage) | +| [`CategoryTree`](types-c-e.md#categorytree) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | | [`RoutableUrl`](#routableurl) | #### Example ```json { - "redirect_code": 987, + "redirect_code": 123, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -1608,15 +1614,15 @@ Default implementation of RoutableInterface. This type is returned when the URL | 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. | +| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -1640,7 +1646,7 @@ Defines the name and value of a SDK parameter ```json { "name": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -1661,8 +1667,8 @@ Contains details about a comment. ```json { - "message": "abc123", - "timestamp": "abc123" + "message": "xyz789", + "timestamp": "xyz789" } ``` @@ -1696,14 +1702,14 @@ Provides navigation for the query response. | 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. | +| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 987, "page_size": 123, "total_pages": 987} +{"current_page": 123, "page_size": 123, "total_pages": 987} ``` @@ -1721,7 +1727,7 @@ A string that contains search suggestion #### Example ```json -{"search": "xyz789"} +{"search": "abc123"} ``` @@ -1734,10 +1740,10 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](types-f-i.md#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 | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example @@ -1746,8 +1752,8 @@ Contains details about a selected bundle option. { "id": 987, "label": "abc123", - "type": "xyz789", - "uid": 4, + "type": "abc123", + "uid": "4", "values": [SelectedBundleOptionValue] } ``` @@ -1762,13 +1768,13 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | +| `id` - [`Int!`](types-f-i.md#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 | +| `original_price` - [`Money!`](types-k-p.md#money) | The original price of the value for the selected bundle product option. | +| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | +| `priceV2` - [`Money!`](types-k-p.md#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example @@ -1777,10 +1783,10 @@ Contains details about a value for a selected bundle option. "id": 987, "label": "abc123", "original_price": Money, - "price": 987.65, + "price": 123.45, "priceV2": Money, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -1794,11 +1800,11 @@ Contains details about a selected configurable option. | 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.)* | +| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](types-f-i.md#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_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | | `value_label` - [`String!`](#string) | The display name of the selected configurable option. | #### Example @@ -1809,7 +1815,7 @@ Contains details about a selected configurable option. "configurable_product_option_value_uid": 4, "id": 123, "option_label": "abc123", - "value_id": 987, + "value_id": 123, "value_label": "abc123" } ``` @@ -1846,11 +1852,11 @@ Identifies a customized product that has been placed in a cart. | 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. | +| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](types-a-b.md#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. | +| `sort_order` - [`Int!`](types-f-i.md#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. | @@ -1863,7 +1869,7 @@ Identifies a customized product that has been placed in a cart. "is_required": false, "label": "xyz789", "sort_order": 123, - "type": "abc123", + "type": "xyz789", "values": [SelectedCustomizableOptionValue] } ``` @@ -1878,10 +1884,10 @@ Identifies the value of the selected customized option. | 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.)* | +| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](types-f-i.md#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. | +| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | | `value` - [`String!`](#string) | The text identifying the selected value. | #### Example @@ -1914,7 +1920,7 @@ Describes the payment method the shopper selected. ```json { - "code": "xyz789", + "code": "abc123", "purchase_order_number": "xyz789", "title": "xyz789" } @@ -1930,14 +1936,14 @@ Contains details about the selected shipping method and carrier. | 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.)* | +| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](types-k-p.md#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. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1946,8 +1952,8 @@ Contains details about the selected shipping method and carrier. "amount": Money, "base_amount": Money, "carrier_code": "xyz789", - "carrier_title": "abc123", - "method_code": "xyz789", + "carrier_title": "xyz789", + "method_code": "abc123", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -1964,7 +1970,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](types-f-i.md#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. | @@ -2039,7 +2045,7 @@ Contains details about a recipient. ```json { - "email": "xyz789", + "email": "abc123", "name": "xyz789" } ``` @@ -2064,7 +2070,7 @@ An output object that contains information about the sender. { "email": "abc123", "message": "abc123", - "name": "xyz789" + "name": "abc123" } ``` @@ -2086,9 +2092,9 @@ Contains details about the sender. ```json { - "email": "xyz789", + "email": "abc123", "message": "abc123", - "name": "xyz789" + "name": "abc123" } ``` @@ -2102,13 +2108,13 @@ Contains details about the configuration of the Email to a Friend feature. | 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. | +| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": true, "enabled_for_guests": false} +{"enabled_for_customers": true, "enabled_for_guests": true} ``` @@ -2121,8 +2127,8 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2143,7 +2149,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2161,7 +2167,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2169,7 +2175,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "abc123" + "cart_id": "xyz789" } ``` @@ -2183,7 +2189,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2202,10 +2208,10 @@ Defines the gift options applied to the cart. | 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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example @@ -2214,8 +2220,8 @@ Defines the gift options applied to the cart. "cart_id": "abc123", "gift_message": GiftMessageInput, "gift_receipt_included": true, - "gift_wrapping_id": 4, - "printed_card_included": true + "gift_wrapping_id": "4", + "printed_card_included": false } ``` @@ -2229,7 +2235,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | #### Example @@ -2254,7 +2260,7 @@ Defines the guest email and cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "email": "abc123" } ``` @@ -2269,7 +2275,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2287,7 +2293,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2305,15 +2311,15 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -2327,7 +2333,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2345,15 +2351,15 @@ Defines the payment method of the specified negotiable quote. | 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. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -2367,7 +2373,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2385,15 +2391,15 @@ Defines the shipping address to assign to the negotiable quote. | 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. | +| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "customer_address_id": 4, + "customer_address_id": "4", "quote_uid": "4", "shipping_addresses": [ NegotiableQuoteShippingAddressInput @@ -2411,7 +2417,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2429,14 +2435,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#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, + "quote_uid": "4", "shipping_methods": [ShippingMethodInput] } ``` @@ -2451,7 +2457,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2469,15 +2475,15 @@ Defines the shipping address to assign to the negotiable quote template. | 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. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": 4 + "template_id": "4" } ``` @@ -2492,13 +2498,13 @@ Applies a payment method to the quote. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "payment_method": PaymentMethodInput } ``` @@ -2514,13 +2520,13 @@ Applies a payment method to the cart. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "payment_method": PaymentMethodInput } ``` @@ -2535,7 +2541,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2575,7 +2581,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2600,7 +2606,7 @@ Applies one or shipping methods to the cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_methods": [ShippingMethodInput] } ``` @@ -2615,7 +2621,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2655,7 +2661,7 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example @@ -2681,7 +2687,7 @@ Defines the sender of an invitation to view a gift registry. ```json { "message": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -2712,12 +2718,12 @@ Defines whether bundle items must be shipped together. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example @@ -2742,31 +2748,31 @@ Order shipment item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example ```json { - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "product_sku": "xyz789", + "quantity_shipped": 123.45 } ``` @@ -2788,9 +2794,9 @@ Contains order shipment tracking details. ```json { - "carrier": "abc123", + "carrier": "xyz789", "number": "abc123", - "title": "xyz789" + "title": "abc123" } ``` @@ -2804,8 +2810,8 @@ Defines a single shipping address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](types-f-i.md#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. | @@ -2816,7 +2822,7 @@ Defines a single shipping address. "address": CartAddressInput, "customer_address_id": 123, "customer_notes": "abc123", - "pickup_location_code": "xyz789" + "pickup_location_code": "abc123" } ``` @@ -2830,25 +2836,25 @@ Contains shipping addresses and methods. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#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. | +| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#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.)* | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. | +| `items_weight` - [`Float`](types-f-i.md#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. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](types-a-b.md#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. | @@ -2867,23 +2873,23 @@ Contains shipping addresses and methods. "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_notes": "abc123", - "fax": "abc123", - "firstname": "abc123", + "customer_notes": "xyz789", + "fax": "xyz789", + "firstname": "xyz789", "id": 987, "items_weight": 123.45, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "pickup_location_code": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CartAddressRegion, "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "suffix": "abc123", + "street": ["xyz789"], + "suffix": "xyz789", "telephone": "abc123", - "uid": "abc123", + "uid": "xyz789", "vat_id": "xyz789" } ``` @@ -2898,7 +2904,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | #### Example @@ -2916,11 +2922,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](types-k-p.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | #### Example @@ -2951,7 +2957,7 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "xyz789", + "carrier_code": "abc123", "method_code": "xyz789" } ``` @@ -2966,23 +2972,23 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#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. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#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 | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#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. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2995,10 +3001,10 @@ An implementation for simple product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "abc123", - "is_available": true, + "is_available": false, "max_qty": 987.65, "min_qty": 123.45, - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -3019,96 +3025,96 @@ Defines a simple product, which is tangible and is usually sold in single units | 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.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#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. | +| `categories` - [`[CategoryInterface]`](types-c-e.md#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.)* | +| `color` - [`Int`](types-f-i.md#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.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#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.)* | +| `format` - [`Int`](types-f-i.md#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. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#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.)* | +| `manufacturer` - [`Int`](types-f-i.md#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.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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 | +| `min_sale_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#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. | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#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.)* | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#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. | +| `small_image` - [`ProductImage`](types-k-p.md#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_price` - [`Float`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#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. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#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. | +| `uid` - [`ID!`](types-f-i.md#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. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#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_rewrites` - [`[UrlRewrite]`](types-t-z.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "abc123", + "activity": "xyz789", "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], @@ -3116,38 +3122,38 @@ Defines a simple product, which is tangible and is usually sold in single units "climate": "abc123", "collar": "xyz789", "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", + "country_of_manufacture": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "eco_collection": 123, + "eco_collection": 987, "erin_recommends": 123, "features_bags": "xyz789", - "format": 987, - "gender": "xyz789", - "gift_message_available": true, - "gift_wrapping_available": false, + "format": 123, + "gender": "abc123", + "gift_message_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "id": 987, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 987, - "material": "abc123", + "manufacturer": 123, + "material": "xyz789", "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", "min_sale_qty": 123.45, "name": "xyz789", - "new": 123, - "new_from_date": "abc123", + "new": 987, + "new_from_date": "xyz789", "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "pattern": "xyz789", "performance_fabric": 123, "price": ProductPrices, @@ -3155,44 +3161,44 @@ Defines a simple product, which is tangible and is usually sold in single units "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 123, - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 123.45, "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 987, + "sale": 123, "short_description": ComplexTextValue, "size": 123, - "sku": "xyz789", + "sku": "abc123", "sleeve": "abc123", "small_image": ProductImage, "special_from_date": "abc123", "special_price": 987.65, - "special_to_date": "abc123", - "staged": false, + "special_to_date": "xyz789", + "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "xyz789", - "style_bottom": "xyz789", - "style_general": "abc123", + "strap_bags": "xyz789", + "style_bags": "abc123", + "style_bottom": "abc123", + "style_general": "xyz789", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", - "uid": "4", - "updated_at": "abc123", + "uid": 4, + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", - "url_path": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -3206,8 +3212,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -3229,9 +3235,9 @@ Contains details about simple products added to a requisition list. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3240,7 +3246,7 @@ Contains details about simple products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -3257,20 +3263,20 @@ Contains a simple 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. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -3293,8 +3299,8 @@ Smart button payment inputs ```json { "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "payments_order_id": "abc123", + "paypal_order_id": "abc123" } ``` @@ -3306,12 +3312,12 @@ Smart button payment inputs | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `button_styles` - [`ButtonStyles`](types-a-b.md#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 | +| `display_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](types-k-p.md#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 | @@ -3325,9 +3331,9 @@ Smart button payment inputs "code": "abc123", "display_message": false, "display_venmo": true, - "is_visible": true, + "is_visible": false, "message_styles": MessageStyles, - "payment_intent": "abc123", + "payment_intent": "xyz789", "sdk_params": [SDKParams], "sort_order": "xyz789", "title": "xyz789" @@ -3392,7 +3398,7 @@ Contains a default value for sort fields and all available sort fields. ```json { - "default": "abc123", + "default": "xyz789", "options": [SortField] } ``` @@ -3465,27 +3471,27 @@ Contains information about a store's configuration. | `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. | +| `autocomplete_on_storefront` - [`Boolean`](types-a-b.md#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_allowspecific` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](types-a-b.md#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_3dsecure_verify_3dsecure` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](types-a-b.md#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_applepay_vault_active` - [`Boolean`](types-a-b.md#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_cc_vault_cvv` - [`Boolean`](types-a-b.md#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_googlepay_vault_active` - [`Boolean`](types-a-b.md#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. | @@ -3493,130 +3499,130 @@ Contains information about a store's configuration. | `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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_cart_type_paypal_show` - [`Boolean`](types-a-b.md#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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_checkout_type_paypal_show` - [`Boolean`](types-a-b.md#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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_button_location_productpage_type_paypal_show` - [`Boolean`](types-a-b.md#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_display_on_shopping_cart` - [`Boolean`](types-a-b.md#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. | +| `braintree_paypal_require_billing_address` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](types-f-i.md#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. | +| `cart_summary_display_quantity` - [`Int`](types-f-i.md#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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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_product_image` - [`ProductImageThumbnail!`](types-k-p.md#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. | +| `contact_enabled` - [`Boolean!`](types-a-b.md#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. | +| `create_account_confirmation` - [`Boolean`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](types-f-i.md#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 | +| `demonotice` - [`Int`](types-f-i.md#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!`](types-f-i.md#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](types-f-i.md#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](types-a-b.md#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 | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](types-a-b.md#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. | +| `graphql_share_all_customer_groups` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_all_customer_groups | +| `graphql_share_customer_group` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](types-f-i.md#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. | +| `grouped_product_image` - [`ProductImageThumbnail!`](types-k-p.md#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 | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_checkout_agreements_enabled` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#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` - [`Int`](types-f-i.md#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. | +| `logo_height` - [`Int`](types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](types-f-i.md#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. | @@ -3631,34 +3637,34 @@ Contains information about a store's configuration. | `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. | +| `max_items_in_order_summary` - [`Int`](types-f-i.md#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. | +| `minicart_display` - [`Boolean`](types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](types-f-i.md#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. | +| `newsletter_enabled` - [`Boolean!`](types-a-b.md#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 | +| `order_cancellation_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](types-a-b.md#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. | +| `printed_card_priceV2` - [`Money`](types-k-p.md#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `quickorder_active` - [`Boolean!`](types-a-b.md#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. | +| `root_category_id` - [`Int`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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`. | @@ -3666,134 +3672,134 @@ Contains information about a store's configuration. | `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. | +| `share_all_catalog_rules` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from catalog/rule/share_all_catalog_rules | +| `share_all_sales_rule` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from promo/graphql/share_all_sales_rule | +| `share_applied_catalog_rules` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from catalog/rule/share_applied_catalog_rules | +| `share_applied_sales_rule` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from promo/graphql/share_applied_sales_rule | +| `shopping_cart_display_full_summary` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#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. | +| `store_sort_order` - [`Int`](types-f-i.md#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.)* | +| `use_store_in_url` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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", + "absolute_footer": "xyz789", "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_items": "xyz789", + "allow_order": "abc123", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, + "autocomplete_on_storefront": true, "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", + "base_static_url": "xyz789", + "base_url": "abc123", + "braintree_3dsecure_allowspecific": true, + "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": 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_environment": "xyz789", "braintree_googlepay_btn_color": "abc123", "braintree_googlepay_cctypes": "abc123", "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": false, + "braintree_googlepay_vault_active": true, "braintree_local_payment_allowed_methods": "abc123", "braintree_local_payment_fallback_button_text": "abc123", "braintree_local_payment_redirect_on_fail": "abc123", - "braintree_merchant_account_id": "xyz789", + "braintree_merchant_account_id": "abc123", "braintree_paypal_button_location_cart_type_credit_color": "abc123", "braintree_paypal_button_location_cart_type_credit_label": "xyz789", - "braintree_paypal_button_location_cart_type_credit_shape": "abc123", + "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_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_messaging_show": false, + "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789", "braintree_paypal_button_location_cart_type_paylater_color": "abc123", "braintree_paypal_button_location_cart_type_paylater_label": "abc123", "braintree_paypal_button_location_cart_type_paylater_shape": "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_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": "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_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": "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_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": "abc123", + "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": "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_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": "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_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_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_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_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": "xyz789", - "braintree_paypal_display_on_shopping_cart": false, + "braintree_paypal_display_on_shopping_cart": true, "braintree_paypal_merchant_country": "abc123", - "braintree_paypal_merchant_name_override": "xyz789", - "braintree_paypal_require_billing_address": true, + "braintree_paypal_merchant_name_override": "abc123", + "braintree_paypal_require_billing_address": false, "braintree_paypal_send_cart_line_items": false, "braintree_paypal_vault_active": true, "cart_expires_in_days": 987, @@ -3803,105 +3809,105 @@ Contains information about a store's configuration. "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_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_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_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": "xyz789", - "cms_home_page": "xyz789", - "cms_no_cookies": "xyz789", - "cms_no_route": "xyz789", + "check_money_order_title": "abc123", + "cms_home_page": "abc123", + "cms_no_cookies": "abc123", + "cms_no_route": "abc123", "code": "xyz789", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "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", + "configurable_thumbnail_source": "abc123", + "contact_enabled": false, + "copyright": "xyz789", + "countries_with_required_region": "xyz789", + "create_account_confirmation": true, + "customer_access_token_lifetime": 123.45, + "default_country": "abc123", + "default_description": "xyz789", "default_display_currency_code": "abc123", - "default_keywords": "abc123", - "default_title": "abc123", - "demonotice": 987, + "default_keywords": "xyz789", + "default_title": "xyz789", + "demonotice": 123, "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": false, + "display_state_if_optional": true, "enable_multiple_wishlists": "xyz789", - "fixed_product_taxes_apply_tax_to_fpt": false, + "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": false, + "fixed_product_taxes_enable": false, + "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "abc123", - "graphql_share_all_customer_groups": true, + "graphql_share_all_customer_groups": false, "graphql_share_customer_group": true, - "grid_per_page": 987, - "grid_per_page_values": "xyz789", + "grid_per_page": 123, + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", "head_includes": "abc123", - "head_shortcut_icon": "abc123", - "header_logo_src": "abc123", + "head_shortcut_icon": "xyz789", + "header_logo_src": "xyz789", "id": 123, - "is_checkout_agreements_enabled": true, - "is_default_store": true, - "is_default_store_group": true, + "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", + "is_requisition_list_active": "xyz789", "list_mode": "xyz789", "list_per_page": 987, "list_per_page_values": "abc123", - "locale": "xyz789", - "logo_alt": "xyz789", - "logo_height": 123, + "locale": "abc123", + "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": "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_customer_limit": "abc123", "magento_reward_points_invitation_order": "abc123", - "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "abc123", - "magento_reward_points_order": "xyz789", + "magento_reward_points_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": "abc123", "max_items_in_order_summary": 123, "maximum_number_of_wishlists": "abc123", - "minicart_display": true, + "minicart_display": false, "minicart_max_items": 987, - "minimum_password_length": "abc123", + "minimum_password_length": "xyz789", "newsletter_enabled": true, - "no_route": "xyz789", - "optional_zip_countries": "xyz789", - "order_cancellation_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": false, - "orders_invoices_credit_memos_display_price": 123, + "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": false, - "payment_payflowpro_cc_vault_active": "abc123", + "payment_payflowpro_cc_vault_active": "xyz789", "printed_card_price": "xyz789", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "abc123", - "product_url_suffix": "abc123", - "quickorder_active": false, + "product_reviews_enabled": "xyz789", + "product_url_suffix": "xyz789", + "quickorder_active": true, "required_character_classes_number": "xyz789", "returns_enabled": "abc123", "root_category_id": 123, @@ -3909,45 +3915,45 @@ Contains information about a store's configuration. "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_all_catalog_rules": true, + "share_all_catalog_rules": false, "share_all_sales_rule": false, - "share_applied_catalog_rules": false, - "share_applied_sales_rule": true, - "shopping_cart_display_full_summary": false, + "share_applied_catalog_rules": true, + "share_applied_sales_rule": false, + "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_subtotal": 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": false, - "show_cms_breadcrumbs": 987, + "shopping_cart_display_zero_tax": true, + "show_cms_breadcrumbs": 123, "store_code": 4, "store_group_code": "4", - "store_group_name": "abc123", - "store_name": "abc123", + "store_group_name": "xyz789", + "store_name": "xyz789", "store_sort_order": 987, "timezone": "xyz789", - "title_prefix": "abc123", - "title_separator": "xyz789", - "title_suffix": "xyz789", + "title_prefix": "xyz789", + "title_separator": "abc123", + "title_suffix": "abc123", "use_store_in_url": false, - "website_code": "4", - "website_id": 123, + "website_code": 4, + "website_id": 987, "website_name": "abc123", - "weight_unit": "xyz789", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": true, + "weight_unit": "abc123", + "welcome": "xyz789", + "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_payment_action": "abc123", "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "xyz789" + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "abc123" } ``` @@ -3961,20 +3967,20 @@ Indicates where an attribute can be displayed. | 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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example ```json { - "position": 123, + "position": 987, "use_in_layered_navigation": "NO", - "use_in_product_listing": false, - "use_in_search_results_layered_navigation": false, + "use_in_product_listing": true, + "use_in_search_results_layered_navigation": true, "visible_on_catalog_pages": false } ``` @@ -3990,7 +3996,7 @@ represent free-form human-readable text. #### Example ```json -"abc123" +"xyz789" ``` @@ -4004,11 +4010,11 @@ Specifies the quote template properties to update. | 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 | +| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](types-f-i.md#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. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -4016,12 +4022,12 @@ Specifies the quote template properties to update. { "comment": "xyz789", "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], - "template_id": "4" + "template_id": 4 } ``` @@ -4082,7 +4088,7 @@ Describes the swatch type and a value. ```json { "type": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -4100,14 +4106,14 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | +| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -4153,7 +4159,7 @@ Swatch attribute metadata input types. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](types-f-i.md#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.)* | @@ -4163,7 +4169,7 @@ Swatch attribute metadata input types. ```json { "items_count": 987, - "label": "abc123", + "label": "xyz789", "swatch_data": SwatchData, "value_string": "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 index a56614469..4e5c90c6c 100644 --- 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 @@ -8,16 +8,16 @@ Contains tax item details. | 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. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | #### Example ```json { "amount": Money, - "rate": 123.45, + "rate": 987.65, "title": "xyz789" } ``` @@ -48,12 +48,12 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -86,9 +86,9 @@ Defines a price based on the quantity purchased. | 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. | +| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -110,8 +110,8 @@ Modifies the specified items in the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example @@ -132,8 +132,8 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | #### Example @@ -154,7 +154,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -172,7 +172,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -190,7 +190,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -208,7 +208,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -226,7 +226,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | +| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | #### Example @@ -244,12 +244,12 @@ Defines updates to a `GiftRegistry` object. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -258,7 +258,7 @@ Defines updates to a `GiftRegistry` object. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "abc123", + "event_name": "xyz789", "message": "abc123", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, @@ -276,17 +276,17 @@ Defines updates to an item in a gift registry. | 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. | +| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { - "gift_registry_item_uid": "4", + "gift_registry_item_uid": 4, "note": "xyz789", - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -300,7 +300,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -318,7 +318,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -336,11 +336,11 @@ Defines updates to an existing registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -349,10 +349,10 @@ Defines updates to an existing registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "abc123", + "email": "xyz789", "firstname": "abc123", "gift_registry_registrant_uid": "4", - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -366,7 +366,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -384,7 +384,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -402,15 +402,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -424,7 +424,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -442,15 +442,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": "4" + "template_id": 4 } ``` @@ -486,13 +486,13 @@ Defines the changes to be made to an approval rule. | 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. | +| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example @@ -501,10 +501,10 @@ Defines the changes to be made to an approval rule. "applies_to": ["4"], "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", + "description": "xyz789", "name": "abc123", "status": "ENABLED", - "uid": "4" + "uid": 4 } ``` @@ -518,14 +518,14 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | +| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "name": "xyz789" } ``` @@ -540,10 +540,10 @@ Defines which items in a requisition list to update. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | #### Example @@ -566,7 +566,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -584,7 +584,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -602,8 +602,8 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -626,15 +626,15 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](types-q-s.md#string) | The request URL. | #### Example ```json { "parameters": [HttpQueryParameter], - "url": "abc123" + "url": "xyz789" } ``` @@ -688,15 +688,15 @@ Defines the input for returning matching companies the customer is assigned to. | 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. | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example ```json { - "currentPage": 123, + "currentPage": 987, "pageSize": 987, "sort": [CompaniesSortInput] } @@ -712,8 +712,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -734,7 +734,7 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example @@ -773,7 +773,7 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | #### Example @@ -792,7 +792,7 @@ Contains the results of validation attempts. | 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. | +| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -814,7 +814,7 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](#string) | Validation rule value. | +| `value` - [`String`](types-q-s.md#string) | Validation rule value. | #### Example @@ -877,15 +877,15 @@ Retrieves the vault configuration | Field Name | Description | |------------|-------------| -| `is_vault_enabled` - [`Boolean`](#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The parameters required to load the Paypal JS SDK | +| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | | `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | #### Example ```json { - "is_vault_enabled": false, + "is_vault_enabled": true, "sdk_params": [SDKParams], "three_ds_mode": "OFF" } @@ -901,19 +901,19 @@ Vault payment inputs | 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. | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789", - "public_hash": "xyz789" + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123", + "public_hash": "abc123" } ``` @@ -927,7 +927,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](#paymentsourceinput) | The payment source information | +| `payment_source` - [`PaymentSourceInput!`](types-k-p.md#paymentsourceinput) | The payment source information | #### Example @@ -945,12 +945,12 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | #### Example ```json -{"public_hash": "abc123"} +{"public_hash": "xyz789"} ``` @@ -963,20 +963,20 @@ An implementation for virtual product cart items. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -985,10 +985,10 @@ An implementation for virtual product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "abc123", - "is_available": false, - "max_qty": 123.45, - "min_qty": 987.65, + "id": "xyz789", + "is_available": true, + "max_qty": 987.65, + "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], @@ -1009,133 +1009,133 @@ Defines a virtual product, which is a non-tangible product that does not require | 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 | +| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#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.)* | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#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)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#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 | +| `url_suffix` - [`String`](types-q-s.md#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", + "activity": "xyz789", "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", + "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": "xyz789", + "eco_collection": 123, + "erin_recommends": 987, + "features_bags": "abc123", + "format": 987, + "gender": "abc123", "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "id": 987, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "manufacturer": 987, "material": "abc123", - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 987.65, + "min_sale_qty": 123.45, "name": "xyz789", - "new": 987, - "new_from_date": "xyz789", + "new": 123, + "new_from_date": "abc123", "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", "pattern": "abc123", @@ -1149,38 +1149,38 @@ Defines a virtual product, which is a non-tangible product that does not require "rating_summary": 987.65, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, + "relative_url": "abc123", + "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], "sale": 123, "short_description": ComplexTextValue, "size": 123, "sku": "xyz789", - "sleeve": "xyz789", + "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, + "special_from_date": "abc123", + "special_price": 987.65, "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", - "strap_bags": "abc123", + "strap_bags": "xyz789", "style_bags": "abc123", "style_bottom": "abc123", - "style_general": "abc123", - "swatch_image": "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", + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -1195,8 +1195,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -1217,10 +1217,10 @@ Contains details about virtual products added to a requisition list. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1228,7 +1228,7 @@ Contains details about virtual products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` @@ -1243,12 +1243,12 @@ Contains a virtual product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -1273,23 +1273,23 @@ Deprecated. It should not be used on the storefront. Contains information about | 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.)* | +| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](types-q-s.md#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`](types-f-i.md#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 + "default_group_id": "xyz789", + "id": 987, + "is_default": true, + "name": "abc123", + "sort_order": 987 } ``` @@ -1304,7 +1304,7 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -1344,13 +1344,13 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](types-f-i.md#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_count` - [`Int`](types-f-i.md#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. | +| `name` - [`String`](types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -1359,10 +1359,10 @@ Contains a customer wish list. { "id": "4", "items": [WishlistItem], - "items_count": 987, + "items_count": 123, "items_v2": WishlistItems, "name": "abc123", - "sharing_code": "abc123", + "sharing_code": "xyz789", "updated_at": "abc123", "visibility": "PUBLIC" } @@ -1379,9 +1379,9 @@ Contains details about errors encountered when a customer added wish list items | 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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example @@ -1390,7 +1390,7 @@ Contains details about errors encountered when a customer added wish list items "code": "PRODUCT_NOT_FOUND", "message": "xyz789", "wishlistId": "4", - "wishlistItemId": "4" + "wishlistItemId": 4 } ``` @@ -1425,21 +1425,21 @@ Contains details about a wish list item. | 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 | +| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "description": "xyz789", - "id": 123, + "id": 987, "product": ProductInterface, - "qty": 987.65 + "qty": 123.45 } ``` @@ -1453,14 +1453,14 @@ Specifies the IDs of items to copy and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json { - "quantity": 987.65, + "quantity": 123.45, "wishlist_item_id": "4" } ``` @@ -1475,21 +1475,21 @@ Defines the items to add to a wish list. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](types-q-s.md#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, + "parent_sku": "abc123", + "quantity": 123.45, "selected_options": ["4"], - "sku": "xyz789" + "sku": "abc123" } ``` @@ -1503,24 +1503,24 @@ The interface for wish list items. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | +| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | +| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | +| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | #### Example @@ -1545,13 +1545,16 @@ Specifies the IDs of the items to move and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json -{"quantity": 123.45, "wishlist_item_id": 4} +{ + "quantity": 123.45, + "wishlist_item_id": "4" +} ``` @@ -1564,20 +1567,20 @@ Defines updates to items in a wish list. | 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. | +| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "entered_options": [EnteredOptionInput], - "quantity": 987.65, - "selected_options": [4], + "quantity": 123.45, + "selected_options": ["4"], "wishlist_item_id": "4" } ``` @@ -1593,7 +1596,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1615,10 +1618,10 @@ Deprecated: Use the `Wishlist` type instead. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | #### Example @@ -1626,7 +1629,7 @@ Deprecated: Use the `Wishlist` type instead. { "items": [WishlistItem], "items_count": 123, - "name": "abc123", + "name": "xyz789", "sharing_code": "abc123", "updated_at": "xyz789" } 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 0bfc08858..d0fe05ec9 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 @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": false}}} +{"data": {"acceptCompanyInvitation": {"success": true}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -108,14 +108,14 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -138,13 +138,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -178,13 +178,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -222,13 +222,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -266,14 +266,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -299,7 +299,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -322,14 +322,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -358,7 +358,7 @@ mutation addProductsToCart( ```json { - "cartId": "xyz789", + "cartId": "abc123", "cartItems": [CartItemInput] } ``` @@ -382,13 +382,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -436,13 +436,13 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Creates a new cart and add any type of product to it -**Response:** [`AddProductsToNewCartOutput`](#addproductstonewcartoutput) +**Response:** [`AddProductsToNewCartOutput`](types-a-b.md#addproductstonewcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartItems` - [`[CartItemInput!]!`](#cartiteminput) | An array that defines the products to add to the new cart | +| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the new cart | #### Example @@ -486,14 +486,14 @@ mutation addProductsToNewCart($cartItems: [CartItemInput!]!) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -519,7 +519,7 @@ mutation addProductsToRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [RequisitionListItemsInput] } ``` @@ -542,14 +542,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -599,13 +599,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -645,13 +645,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -695,14 +695,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -759,13 +759,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -799,13 +799,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -849,13 +849,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -889,13 +889,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -929,14 +929,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -965,7 +965,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": ["4"]} +{"wishlistId": "4", "wishlistItemIds": [4]} ``` ##### Response @@ -990,13 +990,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1030,13 +1030,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1070,13 +1070,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -1110,13 +1110,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -1150,13 +1150,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1190,13 +1190,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1240,13 +1240,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1266,7 +1266,7 @@ mutation assignCompareListToCustomer($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -1276,7 +1276,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": true + "result": false } } } @@ -1288,13 +1288,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | | +| `cart_id` - [`String!`](types-q-s.md#string) | | #### Example @@ -1364,7 +1364,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -1392,11 +1392,11 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1408,13 +1408,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1480,7 +1480,7 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -1491,8 +1491,8 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 987.65 + "template_id": "4", + "total_quantity": 123.45 } } } @@ -1504,13 +1504,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | #### Example @@ -1542,7 +1542,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1556,13 +1556,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1606,14 +1606,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | #### Example @@ -1737,8 +1737,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "xyz789", - "newPassword": "xyz789" + "currentPassword": "abc123", + "newPassword": "abc123" } ``` @@ -1756,24 +1756,24 @@ mutation changeCustomerPassword( "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", - "default_billing": "xyz789", + "date_of_birth": "xyz789", + "default_billing": "abc123", "default_shipping": "abc123", - "dob": "abc123", - "email": "abc123", + "dob": "xyz789", + "email": "xyz789", "firstname": "xyz789", - "gender": 123, + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "group_id": 987, + "group_id": 123, "id": 4, "is_subscribed": false, "job_title": "xyz789", "lastname": "xyz789", "middlename": "abc123", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -1790,8 +1790,8 @@ mutation changeCustomerPassword( "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "abc123", - "taxvat": "abc123", + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", "wishlist": Wishlist, @@ -1808,13 +1808,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCartOutput!`](#clearcartoutput) +**Response:** [`ClearCartOutput!`](types-c-e.md#clearcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ClearCartInput!`](#clearcartinput) | An input object that defines cart ID of the shopper. | +| `input` - [`ClearCartInput!`](types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | #### Example @@ -1858,13 +1858,13 @@ mutation clearCart($input: ClearCartInput!) { Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1884,7 +1884,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "abc123"} +{"cartUid": "xyz789"} ``` ##### Response @@ -1892,7 +1892,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": true} + "clearCustomerCart": {"cart": Cart, "status": false} } } ``` @@ -1903,13 +1903,13 @@ mutation clearCustomerCart($cartUid: String!) { Remove all the products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | #### Example @@ -1953,13 +1953,13 @@ mutation clearWishlist($wishlistId: ID!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -2016,13 +2016,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Synchronizes order details and place the order -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompleteOrderInput`](#completeorderinput) | Describes the variables needed to complete or place the order | +| `input` - [`CompleteOrderInput`](types-c-e.md#completeorderinput) | Describes the variables needed to complete or place the order | #### Example @@ -2070,13 +2070,13 @@ mutation completeOrder($input: CompleteOrderInput) { Cancel the specified guest customer order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmCancelOrderInput!`](#confirmcancelorderinput) | | +| `input` - [`ConfirmCancelOrderInput!`](types-c-e.md#confirmcancelorderinput) | | #### Example @@ -2108,7 +2108,7 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { { "data": { "confirmCancelOrder": { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -2122,13 +2122,13 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -2162,13 +2162,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Confirm the return. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmReturnInput!`](#confirmreturninput) | | +| `input` - [`ConfirmReturnInput!`](types-c-e.md#confirmreturninput) | | #### Example @@ -2212,13 +2212,13 @@ mutation confirmReturn($input: ConfirmReturnInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](#contactusoutput) +**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -2241,7 +2241,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": true}}} +{"data": {"contactUs": {"status": false}}} ``` @@ -2250,15 +2250,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2286,7 +2286,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, + "sourceRequisitionListUid": "4", "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } @@ -2310,15 +2310,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2378,7 +2378,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Example @@ -2406,7 +2406,7 @@ mutation createBraintreeClientToken { Creates Client Token for Braintree PayPal Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Example @@ -2434,13 +2434,13 @@ mutation createBraintreePayPalClientToken { Creates Client Token for Braintree PayPal Vault Javascript SDK initialization. -**Response:** [`String!`](#string) +**Response:** [`String!`](types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `input` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | #### Example @@ -2463,7 +2463,7 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { ```json { "data": { - "createBraintreePayPalVaultClientToken": "abc123" + "createBraintreePayPalVaultClientToken": "xyz789" } } ``` @@ -2474,13 +2474,13 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | #### Example @@ -2514,13 +2514,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | #### Example @@ -2554,13 +2554,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | #### Example @@ -2594,13 +2594,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | #### Example @@ -2634,13 +2634,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | #### Example @@ -2690,13 +2690,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -2730,13 +2730,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | #### Example @@ -2793,30 +2793,30 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { { "data": { "createCustomerAddress": { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 123, - "default_billing": false, + "customer_id": 987, + "default_billing": true, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "xyz789", - "id": 123, - "lastname": "xyz789", + "firstname": "abc123", + "id": 987, + "lastname": "abc123", "middlename": "xyz789", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 987, "street": ["xyz789"], "suffix": "abc123", - "telephone": "abc123", - "uid": 4, - "vat_id": "xyz789" + "telephone": "xyz789", + "uid": "4", + "vat_id": "abc123" } } } @@ -2828,13 +2828,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2872,13 +2872,13 @@ Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](#string) +**Response:** [`String`](types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2899,7 +2899,7 @@ mutation createEmptyCart($input: createEmptyCartInput) { ##### Response ```json -{"data": {"createEmptyCart": "xyz789"}} +{"data": {"createEmptyCart": "abc123"}} ``` @@ -2908,13 +2908,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2952,13 +2952,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | #### Example @@ -2992,13 +2992,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -3030,9 +3030,9 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { "createPayflowProToken": { "response_message": "abc123", "result": 987, - "result_code": 987, - "secure_token": "abc123", - "secure_token_id": "abc123" + "result_code": 123, + "secure_token": "xyz789", + "secure_token_id": "xyz789" } } } @@ -3044,13 +3044,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -3083,7 +3083,7 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { "amount": 123.45, "currency_code": "xyz789", "id": "xyz789", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "status": "xyz789" } } @@ -3096,13 +3096,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -3144,13 +3144,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -3188,13 +3188,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -3238,13 +3238,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "xyz789", + "created_at": "abc123", + "created_by": "abc123", "description": "abc123", "name": "abc123", "status": "ENABLED", "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -3256,13 +3256,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | #### Example @@ -3302,13 +3302,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Creates a vault payment token -**Response:** [`CreateVaultCardPaymentTokenOutput`](#createvaultcardpaymenttokenoutput) +**Response:** [`CreateVaultCardPaymentTokenOutput`](types-c-e.md#createvaultcardpaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardPaymentTokenInput!`](#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | +| `input` - [`CreateVaultCardPaymentTokenInput!`](types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | #### Example @@ -3338,7 +3338,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } } } @@ -3350,13 +3350,13 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) Creates a vault card setup token -**Response:** [`CreateVaultCardSetupTokenOutput`](#createvaultcardsetuptokenoutput) +**Response:** [`CreateVaultCardSetupTokenOutput`](types-c-e.md#createvaultcardsetuptokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardSetupTokenInput!`](#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | +| `input` - [`CreateVaultCardSetupTokenInput!`](types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | #### Example @@ -3394,13 +3394,13 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -3434,13 +3434,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3463,7 +3463,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyRole": {"success": true}}} +{"data": {"deleteCompanyRole": {"success": false}}} ``` @@ -3472,13 +3472,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3514,13 +3514,13 @@ Use deleteCompanyUserV2 instead. The current method only deactivates the user ac Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3537,13 +3537,13 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyUser": {"success": false}}} +{"data": {"deleteCompanyUser": {"success": true}}} ``` @@ -3552,13 +3552,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3581,7 +3581,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyUserV2": {"success": true}}} +{"data": {"deleteCompanyUserV2": {"success": false}}} ``` @@ -3590,13 +3590,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3628,7 +3628,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Example @@ -3656,13 +3656,13 @@ Use `deleteCustomerAddressV2` instead. Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3683,7 +3683,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": false}} +{"data": {"deleteCustomerAddress": true}} ``` @@ -3692,13 +3692,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the customer address to be deleted. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address to be deleted. | #### Example @@ -3713,13 +3713,13 @@ mutation deleteCustomerAddressV2($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response ```json -{"data": {"deleteCustomerAddressV2": true}} +{"data": {"deleteCustomerAddressV2": false}} ``` @@ -3728,13 +3728,13 @@ mutation deleteCustomerAddressV2($uid: ID!) { Delete a negotiable quote template -**Response:** [`Boolean!`](#boolean) +**Response:** [`Boolean!`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3755,7 +3755,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": false}} +{"data": {"deleteNegotiableQuoteTemplate": true}} ``` @@ -3764,13 +3764,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3823,13 +3823,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3849,7 +3849,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "xyz789"} +{"public_hash": "abc123"} ``` ##### Response @@ -3859,7 +3859,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } } } @@ -3871,13 +3871,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3917,13 +3917,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3965,14 +3965,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -4021,13 +4021,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -4047,7 +4047,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -4056,7 +4056,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": false, + "status": true, "wishlists": [Wishlist] } } @@ -4069,13 +4069,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -4113,13 +4113,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -4166,9 +4166,9 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "amount": Money, "available": true, "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "xyz789", - "error_message": "xyz789", + "carrier_code": "xyz789", + "carrier_title": "abc123", + "error_message": "abc123", "method_code": "xyz789", "method_title": "xyz789", "price_excl_tax": Money, @@ -4185,13 +4185,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -4225,13 +4225,13 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`ExchangeExternalCustomerTokenOutput`](#exchangeexternalcustomertokenoutput) +**Response:** [`ExchangeExternalCustomerTokenOutput`](types-c-e.md#exchangeexternalcustomertokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ExchangeExternalCustomerTokenInput`](#exchangeexternalcustomertokeninput) | Contains details about external customer. | +| `input` - [`ExchangeExternalCustomerTokenInput`](types-c-e.md#exchangeexternalcustomertokeninput) | Contains details about external customer. | #### Example @@ -4261,7 +4261,7 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu "data": { "exchangeExternalCustomerToken": { "customer": Customer, - "token": "abc123" + "token": "xyz789" } } } @@ -4273,14 +4273,14 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu Generate a token for specified customer. -**Response:** [`CustomerToken`](#customertoken) +**Response:** [`CustomerToken`](types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -4305,7 +4305,7 @@ mutation generateCustomerToken( ```json { "email": "abc123", - "password": "abc123" + "password": "xyz789" } ``` @@ -4315,7 +4315,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -4327,13 +4327,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -4359,7 +4359,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "xyz789" + "customer_token": "abc123" } } } @@ -4371,13 +4371,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -4400,13 +4400,7 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom ##### Response ```json -{ - "data": { - "generateNegotiableQuoteFromTemplate": { - "negotiable_quote_uid": "4" - } - } -} +{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}} ``` @@ -4415,13 +4409,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -4455,14 +4449,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `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. | +| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4540,7 +4534,7 @@ mutation mergeCarts( ```json { "source_cart_id": "xyz789", - "destination_cart_id": "abc123" + "destination_cart_id": "xyz789" } ``` @@ -4565,7 +4559,7 @@ mutation mergeCarts( "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, @@ -4585,14 +4579,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4621,7 +4615,10 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": "4", "giftRegistryUid": 4} +{ + "cartUid": "4", + "giftRegistryUid": "4" +} ``` ##### Response @@ -4644,15 +4641,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4708,13 +4705,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4754,15 +4751,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4796,7 +4793,7 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, + "sourceWishlistUid": "4", "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } @@ -4822,13 +4819,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4888,14 +4885,14 @@ 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": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -4904,8 +4901,8 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", + "status": "xyz789", + "template_id": 4, "total_quantity": 123.45 } } @@ -4918,13 +4915,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4958,13 +4955,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -5012,13 +5009,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -5056,13 +5053,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | #### Example @@ -5102,13 +5099,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -5140,7 +5137,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } } } @@ -5152,13 +5149,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -5202,13 +5199,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -5242,13 +5239,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -5282,13 +5279,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -5322,13 +5319,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -5351,7 +5348,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Response ```json -{"data": {"removeGiftRegistry": {"success": false}}} +{"data": {"removeGiftRegistry": {"success": true}}} ``` @@ -5360,14 +5357,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -5392,7 +5389,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": 4, "itemsUid": ["4"]} +{"giftRegistryUid": "4", "itemsUid": [4]} ``` ##### Response @@ -5413,14 +5410,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -5446,8 +5443,8 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", - "registrantsUid": [4] + "giftRegistryUid": 4, + "registrantsUid": ["4"] } ``` @@ -5469,13 +5466,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5509,13 +5506,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5555,13 +5552,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5621,10 +5618,10 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, @@ -5637,8 +5634,8 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", + "status": "xyz789", + "template_id": 4, "total_quantity": 123.45 } } @@ -5651,13 +5648,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5691,7 +5688,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": 4 } @@ -5705,14 +5702,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5740,7 +5737,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": [4]} +{"wishlistId": 4, "wishlistItemsIds": ["4"]} ``` ##### Response @@ -5762,13 +5759,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5802,13 +5799,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -5842,13 +5839,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5882,13 +5879,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5926,13 +5923,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](#string) | | +| `orderNumber` - [`String!`](types-q-s.md#string) | | #### Example @@ -5976,13 +5973,13 @@ mutation reorderItems($orderNumber: String!) { Request to cancel specified guest order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderCancelInput!`](#guestordercancelinput) | | +| `input` - [`GuestOrderCancelInput!`](types-f-i.md#guestordercancelinput) | | #### Example @@ -6026,13 +6023,13 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { ### requestGuestReturn -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestGuestReturnInput!`](#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | +| `input` - [`RequestGuestReturnInput!`](types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | #### Example @@ -6076,13 +6073,13 @@ mutation requestGuestReturn($input: RequestGuestReturnInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -6120,13 +6117,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -6188,11 +6185,11 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -6202,9 +6199,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 } } } @@ -6216,13 +6213,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | #### Example @@ -6237,7 +6234,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -6252,13 +6249,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -6302,13 +6299,13 @@ mutation requestReturn($input: RequestReturnInput!) { Resends the confirmation email to a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to send the confirmation email to. | +| `email` - [`String!`](types-q-s.md#string) | The email address to send the confirmation email to. | #### Example @@ -6323,7 +6320,7 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -6338,15 +6335,15 @@ mutation resendConfirmationEmail($email: String!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | 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!`](types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | #### Example @@ -6370,9 +6367,9 @@ mutation resetPassword( ```json { - "email": "xyz789", - "resetPasswordToken": "abc123", - "newPassword": "abc123" + "email": "abc123", + "resetPasswordToken": "xyz789", + "newPassword": "xyz789" } ``` @@ -6388,7 +6385,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) #### Example @@ -6414,13 +6411,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -6464,13 +6461,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -6510,13 +6507,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -6550,13 +6547,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Sets the cart as inactive -**Response:** [`SetCartAsInactiveOutput`](#setcartasinactiveoutput) +**Response:** [`SetCartAsInactiveOutput`](types-q-s.md#setcartasinactiveoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | #### Example @@ -6574,7 +6571,7 @@ mutation setCartAsInactive($cartId: String!) { ##### Variables ```json -{"cartId": "xyz789"} +{"cartId": "abc123"} ``` ##### Response @@ -6596,13 +6593,13 @@ mutation setCartAsInactive($cartId: String!) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -6636,13 +6633,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6676,13 +6673,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6716,13 +6713,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6762,13 +6759,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6808,13 +6805,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6854,13 +6851,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6900,13 +6897,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6968,12 +6965,12 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "abc123", + "max_order_commitment": 123, + "min_order_commitment": 123, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6983,7 +6980,7 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", + "template_id": 4, "total_quantity": 987.65 } } @@ -7000,13 +6997,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -7054,13 +7051,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -7094,13 +7091,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -7160,14 +7157,14 @@ 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, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -7176,9 +7173,9 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, - "total_quantity": 123.45 + "status": "xyz789", + "template_id": "4", + "total_quantity": 987.65 } } } @@ -7190,13 +7187,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -7230,13 +7227,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -7270,15 +7267,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7304,7 +7301,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7313,7 +7310,7 @@ mutation shareGiftRegistry( ##### Response ```json -{"data": {"shareGiftRegistry": {"is_shared": false}}} +{"data": {"shareGiftRegistry": {"is_shared": true}}} ``` @@ -7322,13 +7319,13 @@ mutation shareGiftRegistry( Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -7388,13 +7385,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "submitNegotiableQuoteTemplateForReview": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7404,8 +7401,8 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", + "status": "abc123", + "template_id": 4, "total_quantity": 987.65 } } @@ -7418,13 +7415,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -7456,13 +7453,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -7483,7 +7480,7 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": true}} +{"data": {"syncPaymentOrder": false}} ``` @@ -7492,13 +7489,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -7542,13 +7539,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | #### Example @@ -7582,13 +7579,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | #### Example @@ -7622,13 +7619,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | #### Example @@ -7662,13 +7659,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | #### Example @@ -7702,13 +7699,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | #### Example @@ -7744,13 +7741,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7788,14 +7785,14 @@ Use `updateCustomerAddressV2` instead. Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7849,7 +7846,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 987, "input": CustomerAddressInput} +{"id": 123, "input": CustomerAddressInput} ``` ##### Response @@ -7858,29 +7855,29 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", - "country_id": "abc123", + "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": true, - "default_shipping": true, + "default_billing": false, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", - "id": 123, + "id": 987, "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", - "uid": "4", + "uid": 4, "vat_id": "abc123" } } @@ -7893,14 +7890,14 @@ mutation updateCustomerAddress( Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the customer address. | -| `input` - [`CustomerAddressInput`](#customeraddressinput) | An input object that contains changes to the customer address. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address. | +| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7954,7 +7951,10 @@ mutation updateCustomerAddressV2( ##### Variables ```json -{"uid": 4, "input": CustomerAddressInput} +{ + "uid": "4", + "input": CustomerAddressInput +} ``` ##### Response @@ -7963,18 +7963,18 @@ mutation updateCustomerAddressV2( { "data": { "updateCustomerAddressV2": { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 987, + "customer_id": 123, "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "id": 987, "lastname": "abc123", "middlename": "abc123", @@ -7986,7 +7986,7 @@ mutation updateCustomerAddressV2( "suffix": "xyz789", "telephone": "abc123", "uid": "4", - "vat_id": "xyz789" + "vat_id": "abc123" } } } @@ -7998,14 +7998,14 @@ mutation updateCustomerAddressV2( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -8031,8 +8031,8 @@ mutation updateCustomerEmail( ```json { - "email": "xyz789", - "password": "abc123" + "email": "abc123", + "password": "xyz789" } ``` @@ -8048,13 +8048,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -8088,14 +8088,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -8142,14 +8142,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -8198,14 +8198,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -8254,13 +8254,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -8300,13 +8300,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -8346,14 +8346,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -8406,13 +8406,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -8456,13 +8456,13 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", + "created_at": "xyz789", "created_by": "xyz789", - "description": "xyz789", - "name": "abc123", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } } } @@ -8474,14 +8474,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -8507,7 +8507,7 @@ mutation updateRequisitionList( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "input": UpdateRequisitionListInput } ``` @@ -8530,14 +8530,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -8563,7 +8563,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItems": [ UpdateRequisitionListItemsInput ] @@ -8588,15 +8588,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to update. | -| `name` - [`String`](#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -8624,7 +8624,7 @@ mutation updateWishlist( ```json { - "wishlistId": "4", + "wishlistId": 4, "name": "abc123", "visibility": "PUBLIC" } @@ -8650,13 +8650,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | #### Example 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 6617a62b0..49f4b4412 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](#attributesformoutput) +**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](#string) | Form code. | +| `formCode` - [`String!`](types-q-s.md#string) | Form code. | #### Example @@ -70,14 +70,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -130,13 +130,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](#storeconfig) +**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -411,96 +411,96 @@ query availableStores($useCurrentGroup: Boolean) { { "absolute_footer": "xyz789", "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "abc123", + "allow_guests_to_write_product_reviews": "xyz789", "allow_items": "abc123", "allow_order": "xyz789", "allow_printed_card": "abc123", "autocomplete_on_storefront": false, - "base_currency_code": "xyz789", - "base_link_url": "abc123", + "base_currency_code": "abc123", + "base_link_url": "xyz789", "base_media_url": "abc123", - "base_static_url": "xyz789", - "base_url": "abc123", + "base_static_url": "abc123", + "base_url": "xyz789", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": false, - "braintree_3dsecure_specificcountry": "abc123", - "braintree_3dsecure_threshold_amount": "xyz789", - "braintree_3dsecure_verify_3dsecure": true, - "braintree_ach_direct_debit_vault_active": false, + "braintree_3dsecure_specificcountry": "xyz789", + "braintree_3dsecure_threshold_amount": "abc123", + "braintree_3dsecure_verify_3dsecure": false, + "braintree_ach_direct_debit_vault_active": true, "braintree_applepay_merchant_name": "xyz789", - "braintree_applepay_vault_active": true, + "braintree_applepay_vault_active": false, "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": false, + "braintree_cc_vault_cvv": true, "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "xyz789", - "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_btn_color": "abc123", + "braintree_googlepay_cctypes": "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_allowed_methods": "xyz789", + "braintree_local_payment_fallback_button_text": "abc123", "braintree_local_payment_redirect_on_fail": "xyz789", - "braintree_merchant_account_id": "xyz789", + "braintree_merchant_account_id": "abc123", "braintree_paypal_button_location_cart_type_credit_color": "abc123", "braintree_paypal_button_location_cart_type_credit_label": "xyz789", - "braintree_paypal_button_location_cart_type_credit_shape": "abc123", - "braintree_paypal_button_location_cart_type_credit_show": true, - "braintree_paypal_button_location_cart_type_messaging_layout": "abc123", - "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", - "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_show": true, - "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789", - "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", + "braintree_paypal_button_location_cart_type_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": "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_show": true, + "braintree_paypal_button_location_cart_type_paypal_color": "abc123", "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_show": true, - "braintree_paypal_button_location_checkout_type_credit_color": "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": "abc123", - "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", + "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_logo": "xyz789", + "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": "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": true, + "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": "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_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": "xyz789", - "braintree_paypal_button_location_productpage_type_credit_shape": "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": "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_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": "xyz789", + "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_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_paylater_show": false, + "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789", "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789", "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123", - "braintree_paypal_button_location_productpage_type_paypal_show": true, + "braintree_paypal_button_location_productpage_type_paypal_show": false, "braintree_paypal_credit_uk_merchant_name": "abc123", "braintree_paypal_display_on_shopping_cart": false, - "braintree_paypal_merchant_country": "xyz789", + "braintree_paypal_merchant_country": "abc123", "braintree_paypal_merchant_name_override": "abc123", - "braintree_paypal_require_billing_address": false, + "braintree_paypal_require_billing_address": true, "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": false, - "cart_expires_in_days": 123, + "braintree_paypal_vault_active": true, + "cart_expires_in_days": 987, "cart_gift_wrapping": "abc123", "cart_merge_preference": "abc123", "cart_printed_card": "xyz789", @@ -508,149 +508,149 @@ query availableStores($useCurrentGroup: Boolean) { "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_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_max_order_total": "abc123", "check_money_order_min_order_total": "abc123", - "check_money_order_new_order_status": "abc123", - "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_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": "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", + "cms_no_cookies": "abc123", + "cms_no_route": "abc123", + "code": "abc123", "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": 123.45, + "copyright": "xyz789", + "countries_with_required_region": "xyz789", + "create_account_confirmation": false, + "customer_access_token_lifetime": 987.65, "default_country": "xyz789", - "default_description": "xyz789", + "default_description": "abc123", "default_display_currency_code": "abc123", "default_keywords": "xyz789", "default_title": "abc123", "demonotice": 987, - "display_product_prices_in_catalog": 987, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 123, "display_state_if_optional": true, - "enable_multiple_wishlists": "abc123", - "fixed_product_taxes_apply_tax_to_fpt": true, - "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 987, + "enable_multiple_wishlists": "xyz789", + "fixed_product_taxes_apply_tax_to_fpt": false, + "fixed_product_taxes_display_prices_in_emails": 123, + "fixed_product_taxes_display_prices_in_product_lists": 123, "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 123, - "fixed_product_taxes_enable": false, + "fixed_product_taxes_display_prices_on_product_view_page": 987, + "fixed_product_taxes_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "abc123", - "graphql_share_customer_group": true, - "grid_per_page": 123, + "graphql_share_customer_group": false, + "grid_per_page": 987, "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", "head_includes": "xyz789", "head_shortcut_icon": "abc123", "header_logo_src": "abc123", - "id": 987, - "is_checkout_agreements_enabled": false, + "id": 123, + "is_checkout_agreements_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_negotiable_quote_active": false, + "is_one_page_checkout_enabled": true, "is_requisition_list_active": "abc123", "list_mode": "xyz789", - "list_per_page": 123, - "list_per_page_values": "xyz789", - "locale": "xyz789", + "list_per_page": 987, + "list_per_page_values": "abc123", + "locale": "abc123", "logo_alt": "xyz789", "logo_height": 123, - "logo_width": 123, - "magento_reward_general_is_enabled": "xyz789", + "logo_width": 987, + "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_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "xyz789", - "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "abc123", - "magento_reward_points_order": "abc123", - "magento_reward_points_register": "abc123", - "magento_reward_points_review": "abc123", + "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": "abc123", - "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": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "xyz789", + "minicart_display": true, + "minicart_max_items": 987, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, + "no_route": "abc123", + "optional_zip_countries": "xyz789", "order_cancellation_enabled": true, "order_cancellation_reasons": [ CancellationReason ], - "orders_invoices_credit_memos_display_full_summary": false, + "orders_invoices_credit_memos_display_full_summary": true, "orders_invoices_credit_memos_display_grandtotal": false, - "orders_invoices_credit_memos_display_price": 987, + "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_subtotal": 987, "orders_invoices_credit_memos_display_zero_tax": true, "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "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", - "quickorder_active": true, - "required_character_classes_number": "xyz789", - "returns_enabled": "xyz789", - "root_category_id": 123, + "quickorder_active": false, + "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_gift_wrapping": "xyz789", "sales_printed_card": "abc123", "secure_base_link_url": "xyz789", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "share_active_segments": true, + "share_active_segments": false, "share_applied_cart_rule": false, "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 123, + "shopping_cart_display_grand_total": true, + "shopping_cart_display_price": 987, "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 987, "store_code": 4, - "store_group_code": "4", + "store_group_code": 4, "store_group_name": "abc123", - "store_name": "xyz789", + "store_name": "abc123", "store_sort_order": 123, "timezone": "xyz789", "title_prefix": "abc123", - "title_separator": "abc123", + "title_separator": "xyz789", "title_suffix": "abc123", - "use_store_in_url": false, - "website_code": 4, - "website_id": 123, - "website_name": "xyz789", + "use_store_in_url": true, + "website_code": "4", + "website_id": 987, + "website_name": "abc123", "weight_unit": "abc123", "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_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 123, + "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enabled": true, + "zero_subtotal_new_order_status": "xyz789", + "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "xyz789" } ] @@ -664,13 +664,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](#cart) +**Response:** [`Cart`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -768,11 +768,11 @@ query cart($cart_id: String!) { "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -784,15 +784,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](#categoryresult) +**Response:** [`CategoryResult`](types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -838,7 +838,7 @@ query categories( "categories": { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -854,13 +854,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](#categorytree) +**Response:** [`CategoryTree`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -931,41 +931,41 @@ query category($id: Int) { "data": { "category": { "automatic_sorting": "xyz789", - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], - "children_count": "xyz789", + "children_count": "abc123", "cms_block": CmsBlock, "created_at": "xyz789", "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", "description": "xyz789", - "display_mode": "xyz789", - "filter_price_range": 123.45, + "display_mode": "abc123", + "filter_price_range": 987.65, "id": 987, - "image": "xyz789", - "include_in_menu": 987, - "is_anchor": 987, - "landing_page": 123, - "level": 123, - "meta_description": "abc123", + "image": "abc123", + "include_in_menu": 123, + "is_anchor": 123, + "landing_page": 987, + "level": 987, + "meta_description": "xyz789", "meta_keywords": "abc123", "meta_title": "abc123", "name": "abc123", - "path": "abc123", + "path": "xyz789", "path_in_store": "xyz789", - "position": 987, - "product_count": 123, + "position": 123, + "product_count": 987, "products": CategoryProducts, - "redirect_code": 123, + "redirect_code": 987, "relative_url": "xyz789", - "staged": false, + "staged": true, "type": "CMS_PAGE", "uid": "4", - "updated_at": "xyz789", - "url_key": "abc123", - "url_path": "xyz789", + "updated_at": "abc123", + "url_key": "xyz789", + "url_path": "abc123", "url_suffix": "abc123" } } @@ -982,15 +982,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](#categorytree) +**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -1074,11 +1074,11 @@ query categoryList( "categoryList": [ { "automatic_sorting": "xyz789", - "available_sort_by": ["abc123"], + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "abc123", "custom_layout_update_file": "abc123", @@ -1090,26 +1090,26 @@ query categoryList( "image": "abc123", "include_in_menu": 123, "is_anchor": 123, - "landing_page": 987, - "level": 987, - "meta_description": "xyz789", + "landing_page": 123, + "level": 123, + "meta_description": "abc123", "meta_keywords": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "xyz789", - "path": "abc123", - "path_in_store": "xyz789", - "position": 123, - "product_count": 987, + "path": "xyz789", + "path_in_store": "abc123", + "position": 987, + "product_count": 123, "products": CategoryProducts, "redirect_code": 123, - "relative_url": "abc123", - "staged": false, + "relative_url": "xyz789", + "staged": true, "type": "CMS_PAGE", "uid": "4", - "updated_at": "abc123", - "url_key": "abc123", + "updated_at": "xyz789", + "url_key": "xyz789", "url_path": "abc123", - "url_suffix": "abc123" + "url_suffix": "xyz789" } ] } @@ -1122,7 +1122,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) #### Example @@ -1149,13 +1149,13 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 123, + "agreement_id": 987, "checkbox_text": "abc123", - "content": "abc123", + "content": "xyz789", "content_height": "xyz789", - "is_html": true, + "is_html": false, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ] } @@ -1168,13 +1168,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](#cmsblocks) +**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -1193,7 +1193,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["xyz789"]} +{"identifiers": ["abc123"]} ``` ##### Response @@ -1208,14 +1208,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](#cmspage) +**Response:** [`CmsPage`](types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](#int) | The ID of the CMS page. | -| `identifier` - [`String`](#string) | The identifier of the CMS page. | +| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -1259,15 +1259,15 @@ query cmsPage( "data": { "cmsPage": { "content": "abc123", - "content_heading": "abc123", - "identifier": "abc123", + "content_heading": "xyz789", + "identifier": "xyz789", "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "xyz789", - "page_layout": "abc123", - "redirect_code": 987, - "relative_url": "abc123", - "title": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "page_layout": "xyz789", + "redirect_code": 123, + "relative_url": "xyz789", + "title": "abc123", "type": "CMS_PAGE", "url_key": "xyz789" } @@ -1281,7 +1281,7 @@ query cmsPage( Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](#company) +**Response:** [`Company`](types-c-e.md#company) #### Example @@ -1348,10 +1348,10 @@ query company { "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": "4", + "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "abc123", + "name": "xyz789", "payment_methods": ["xyz789"], "reseller_id": "xyz789", "role": CompanyRole, @@ -1361,7 +1361,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -1373,13 +1373,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1427,7 +1427,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](#country) +**Response:** [`[Country]`](types-c-e.md#country) #### Example @@ -1456,11 +1456,11 @@ query countries { "countries": [ { "available_regions": [Region], - "full_name_english": "xyz789", + "full_name_english": "abc123", "full_name_locale": "abc123", - "id": "xyz789", + "id": "abc123", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } ] } @@ -1473,13 +1473,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](#country) +**Response:** [`Country`](types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](#string) | | +| `id` - [`String`](types-q-s.md#string) | | #### Example @@ -1503,7 +1503,7 @@ query country($id: String) { ##### Variables ```json -{"id": "xyz789"} +{"id": "abc123"} ``` ##### Response @@ -1514,8 +1514,8 @@ query country($id: String) { "country": { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "xyz789", - "id": "abc123", + "full_name_locale": "abc123", + "id": "xyz789", "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" } @@ -1529,7 +1529,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](#currency) +**Response:** [`Currency`](types-c-e.md#currency) #### Example @@ -1561,11 +1561,11 @@ query currency { "available_currency_codes": [ "abc123" ], - "base_currency_code": "abc123", - "base_currency_symbol": "xyz789", + "base_currency_code": "xyz789", + "base_currency_symbol": "abc123", "default_display_currecy_code": "abc123", "default_display_currecy_symbol": "abc123", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } @@ -1583,13 +1583,13 @@ Use `customAttributeMetadataV2` query instead. Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1627,13 +1627,13 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | #### Example @@ -1677,7 +1677,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Example @@ -1807,20 +1807,20 @@ query customer { "custom_attributes": [AttributeValueInterface], "date_of_birth": "abc123", "default_billing": "xyz789", - "default_shipping": "abc123", + "default_shipping": "xyz789", "dob": "abc123", "email": "abc123", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "group_id": 987, "id": "4", - "is_subscribed": true, + "is_subscribed": false, "job_title": "xyz789", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -1838,11 +1838,11 @@ query customer { "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, + "structure_id": "4", "suffix": "abc123", - "taxvat": "xyz789", + "taxvat": "abc123", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1857,7 +1857,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Example @@ -1940,20 +1940,20 @@ query customerCart { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "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": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1965,7 +1965,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) #### Example @@ -1999,7 +1999,7 @@ query customerDownloadableProducts { Provides Customer Group assigned to the Customer or Guest. -**Response:** [`CustomerGroupStorefront!`](#customergroupstorefront) +**Response:** [`CustomerGroupStorefront!`](types-c-e.md#customergroupstorefront) #### Example @@ -2027,7 +2027,7 @@ query customerGroup { Use the `customer` query instead. -**Response:** [`CustomerOrders`](#customerorders) +**Response:** [`CustomerOrders`](types-c-e.md#customerorders) #### Example @@ -2057,7 +2057,7 @@ query customerOrders { "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -2069,7 +2069,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) #### Example @@ -2101,13 +2101,13 @@ query customerPaymentTokens { Customer segments associated with the current customer or guest/visitor. -**Response:** [`[CustomerSegmentStorefront]`](#customersegmentstorefront) +**Response:** [`[CustomerSegmentStorefront]`](types-c-e.md#customersegmentstorefront) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The unique ID of the cart to query. | +| `cartId` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -2139,15 +2139,15 @@ query customerSegments($cartId: String!) { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](#dynamicblocks) +**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -2205,13 +2205,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](#hostedprourl) +**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -2249,13 +2249,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](#payflowlinktoken) +**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2285,9 +2285,9 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "xyz789", + "paypal_url": "abc123", "secure_token": "xyz789", - "secure_token_id": "abc123" + "secure_token_id": "xyz789" } } } @@ -2299,13 +2299,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2361,14 +2361,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | #### Example @@ -2397,7 +2397,7 @@ query getPaymentOrder( ```json { - "cartId": "xyz789", + "cartId": "abc123", "id": "abc123" } ``` @@ -2408,10 +2408,10 @@ query getPaymentOrder( { "data": { "getPaymentOrder": { - "id": "xyz789", + "id": "abc123", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -2423,13 +2423,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2467,7 +2467,7 @@ query getPaymentSDK($location: PaymentLocation!) { Retrieves the vault configuration -**Response:** [`VaultConfigOutput`](#vaultconfigoutput) +**Response:** [`VaultConfigOutput`](types-t-z.md#vaultconfigoutput) #### Example @@ -2501,13 +2501,13 @@ query getVaultConfig { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -2551,13 +2551,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](#giftregistry) +**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -2595,7 +2595,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -2610,14 +2610,14 @@ query giftRegistry($giftRegistryUid: ID!) { ], "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "abc123", + "message": "abc123", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } } } @@ -2629,13 +2629,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | #### Example @@ -2685,13 +2685,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -2726,8 +2726,8 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": "4", - "location": "abc123", - "name": "abc123", + "location": "xyz789", + "name": "xyz789", "type": "xyz789" } ] @@ -2741,15 +2741,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](#string) | The first name of the registrant. | -| `lastName` - [`String!`](#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](#id) | The type UID of the registry. | +| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2780,9 +2780,9 @@ query giftRegistryTypeSearch( ```json { - "firstName": "xyz789", + "firstName": "abc123", "lastName": "xyz789", - "giftRegistryTypeUid": 4 + "giftRegistryTypeUid": "4" } ``` @@ -2793,10 +2793,10 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "xyz789", - "event_title": "abc123", + "event_date": "abc123", + "event_title": "xyz789", "gift_registry_uid": 4, - "location": "xyz789", + "location": "abc123", "name": "xyz789", "type": "xyz789" } @@ -2811,7 +2811,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](#giftregistrytype) +**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) #### Example @@ -2839,7 +2839,7 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", + "label": "abc123", "uid": 4 } ] @@ -2853,13 +2853,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and billing last name. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderInformationInput!`](#guestorderinformationinput) | | +| `input` - [`GuestOrderInformationInput!`](types-f-i.md#guestorderinformationinput) | | #### Example @@ -2955,14 +2955,14 @@ query guestOrder($input: GuestOrderInformationInput!) { "billing_address": OrderAddress, "carrier": "abc123", "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_wrapping": GiftWrapping, - "grand_total": 987.65, + "grand_total": 123.45, "id": 4, "increment_id": "abc123", "invoices": [Invoice], @@ -2970,17 +2970,17 @@ query guestOrder($input: GuestOrderInformationInput!) { "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", - "order_date": "abc123", + "order_date": "xyz789", "order_number": "abc123", "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", + "shipping_method": "xyz789", "status": "abc123", - "token": "xyz789", + "token": "abc123", "total": OrderTotal } } @@ -2993,13 +2993,13 @@ query guestOrder($input: GuestOrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | #### Example @@ -3093,34 +3093,34 @@ query guestOrderByToken($input: OrderTokenInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "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], "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", - "order_date": "abc123", + "number": "abc123", + "order_date": "xyz789", "order_number": "abc123", - "order_status_change_date": "xyz789", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", + "shipping_method": "abc123", "status": "abc123", - "token": "xyz789", + "token": "abc123", "total": OrderTotal } } @@ -3133,13 +3133,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -3156,13 +3156,13 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} ``` @@ -3171,13 +3171,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -3209,13 +3209,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](#string) | | +| `name` - [`String!`](types-q-s.md#string) | | #### Example @@ -3247,13 +3247,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -3276,7 +3276,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}} ``` @@ -3285,13 +3285,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to check. | +| `email` - [`String!`](types-q-s.md#string) | The email address to check. | #### Example @@ -3314,7 +3314,7 @@ query isEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": true}}} +{"data": {"isEmailAvailable": {"is_email_available": false}}} ``` @@ -3323,13 +3323,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](#negotiablequote) +**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | | +| `uid` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3408,7 +3408,7 @@ query negotiableQuote($uid: ID!) { ], "status": "SUBMITTED", "total_quantity": 123.45, - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -3421,13 +3421,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](#id) | | +| `templateId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3476,7 +3476,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": 4} +{"templateId": "4"} ``` ##### Response @@ -3490,10 +3490,10 @@ query negotiableQuoteTemplate($templateId: ID!) { "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -3503,9 +3503,9 @@ query negotiableQuoteTemplate($templateId: ID!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -3517,16 +3517,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -3579,7 +3579,7 @@ query negotiableQuoteTemplates( "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -3591,16 +3591,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3653,7 +3653,7 @@ query negotiableQuotes( "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -3665,18 +3665,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](#pickuplocations) +**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3731,7 +3731,7 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -3743,7 +3743,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) #### Example @@ -3777,17 +3777,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](#products) +**Response:** [`Products`](types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -3865,13 +3865,13 @@ query products( ### recaptchaFormConfig -**Response:** [`ReCaptchaConfigOutput`](#recaptchaconfigoutput) +**Response:** [`ReCaptchaConfigOutput`](types-q-s.md#recaptchaconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `formType` - [`ReCaptchaFormEnum!`](#recaptchaformenum) | | +| `formType` - [`ReCaptchaFormEnum!`](types-q-s.md#recaptchaformenum) | | #### Example @@ -3913,7 +3913,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3943,9 +3943,9 @@ query recaptchaV3Config { "badge_position": "xyz789", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "xyz789", - "minimum_score": 123.45, + "is_enabled": false, + "language_code": "abc123", + "minimum_score": 987.65, "theme": "abc123", "website_key": "abc123" } @@ -3959,13 +3959,13 @@ query recaptchaV3Config { Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](#routableinterface) +**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3984,7 +3984,7 @@ query route($url: String!) { ##### Variables ```json -{"url": "xyz789"} +{"url": "abc123"} ``` ##### Response @@ -3994,7 +3994,7 @@ query route($url: String!) { "data": { "route": { "redirect_code": 987, - "relative_url": "xyz789", + "relative_url": "abc123", "type": "CMS_PAGE" } } @@ -4007,7 +4007,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](#storeconfig) +**Response:** [`StoreConfig`](types-q-s.md#storeconfig) #### Example @@ -4274,246 +4274,246 @@ query storeConfig { "data": { "storeConfig": { "absolute_footer": "abc123", - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "abc123", - "allow_guests_to_write_product_reviews": "xyz789", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order_items": "xyz789", + "allow_guests_to_write_product_reviews": "abc123", "allow_items": "abc123", - "allow_order": "abc123", - "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, + "allow_order": "xyz789", + "allow_printed_card": "abc123", + "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", + "base_url": "abc123", "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": true, - "braintree_3dsecure_specificcountry": "abc123", + "braintree_3dsecure_always_request_3ds": false, + "braintree_3dsecure_specificcountry": "xyz789", "braintree_3dsecure_threshold_amount": "xyz789", "braintree_3dsecure_verify_3dsecure": true, - "braintree_ach_direct_debit_vault_active": true, + "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_cc_vault_active": "xyz789", + "braintree_cc_vault_cvv": false, "braintree_environment": "abc123", "braintree_googlepay_btn_color": "abc123", - "braintree_googlepay_cctypes": "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": "abc123", - "braintree_local_payment_redirect_on_fail": "abc123", - "braintree_merchant_account_id": "abc123", + "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": "xyz789", "braintree_paypal_button_location_cart_type_credit_label": "abc123", "braintree_paypal_button_location_cart_type_credit_shape": "xyz789", "braintree_paypal_button_location_cart_type_credit_show": true, "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789", + "braintree_paypal_button_location_cart_type_messaging_logo": "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_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_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": 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": "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": "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": "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_logo": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_show": true, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_show": 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": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "abc123", - "braintree_paypal_button_location_productpage_type_credit_label": "abc123", - "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789", - "braintree_paypal_button_location_productpage_type_credit_show": false, - "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123", + "braintree_paypal_button_location_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": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", + "braintree_paypal_button_location_checkout_type_paypal_show": false, + "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_shape": "abc123", + "braintree_paypal_button_location_productpage_type_credit_show": true, + "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789", "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789", "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789", "braintree_paypal_button_location_productpage_type_messaging_show": false, "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_color": "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_color": "xyz789", + "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": "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": false, - "braintree_paypal_credit_uk_merchant_name": "xyz789", - "braintree_paypal_display_on_shopping_cart": true, - "braintree_paypal_merchant_country": "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": true, + "braintree_paypal_credit_uk_merchant_name": "abc123", + "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_require_billing_address": false, "braintree_paypal_send_cart_line_items": false, "braintree_paypal_vault_active": true, "cart_expires_in_days": 123, - "cart_gift_wrapping": "xyz789", + "cart_gift_wrapping": "abc123", "cart_merge_preference": "xyz789", - "cart_printed_card": "abc123", + "cart_printed_card": "xyz789", "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "xyz789", + "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": false, + "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": "abc123", - "check_money_order_min_order_total": "xyz789", - "check_money_order_new_order_status": "abc123", + "check_money_order_max_order_total": "xyz789", + "check_money_order_min_order_total": "abc123", + "check_money_order_new_order_status": "xyz789", "check_money_order_payment_from_specific_countries": "xyz789", "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 987, + "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", - "cms_home_page": "abc123", + "cms_home_page": "xyz789", "cms_no_cookies": "abc123", - "cms_no_route": "xyz789", - "code": "xyz789", + "cms_no_route": "abc123", + "code": "abc123", "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "abc123", - "contact_enabled": false, + "contact_enabled": true, "copyright": "xyz789", "countries_with_required_region": "xyz789", "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, - "default_country": "xyz789", + "customer_access_token_lifetime": 987.65, + "default_country": "abc123", "default_description": "abc123", "default_display_currency_code": "xyz789", - "default_keywords": "abc123", + "default_keywords": "xyz789", "default_title": "xyz789", - "demonotice": 987, - "display_product_prices_in_catalog": 123, - "display_shipping_prices": 123, + "demonotice": 123, + "display_product_prices_in_catalog": 987, + "display_shipping_prices": 987, "display_state_if_optional": false, "enable_multiple_wishlists": "abc123", "fixed_product_taxes_apply_tax_to_fpt": 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": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 123, - "fixed_product_taxes_enable": true, - "fixed_product_taxes_include_fpt_in_subtotal": true, + "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_customer_group": true, - "grid_per_page": 123, + "graphql_share_customer_group": false, + "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, + "header_logo_src": "abc123", + "id": 987, "is_checkout_agreements_enabled": true, "is_default_store": false, "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": "xyz789", - "list_mode": "abc123", + "list_mode": "xyz789", "list_per_page": 123, "list_per_page_values": "abc123", "locale": "xyz789", "logo_alt": "abc123", "logo_height": 987, - "logo_width": 987, + "logo_width": 123, "magento_reward_general_is_enabled": "abc123", "magento_reward_general_is_enabled_on_front": "abc123", - "magento_reward_general_min_points_balance": "xyz789", - "magento_reward_general_publish_history": "abc123", + "magento_reward_general_min_points_balance": "abc123", + "magento_reward_general_publish_history": "xyz789", "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "xyz789", - "magento_reward_points_invitation_order": "abc123", + "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "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": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", + "magento_reward_points_register": "abc123", + "magento_reward_points_review": "xyz789", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "abc123", "max_items_in_order_summary": 123, "maximum_number_of_wishlists": "xyz789", - "minicart_display": false, + "minicart_display": true, "minicart_max_items": 123, - "minimum_password_length": "abc123", + "minimum_password_length": "xyz789", "newsletter_enabled": false, - "no_route": "xyz789", - "optional_zip_countries": "abc123", - "order_cancellation_enabled": false, + "no_route": "abc123", + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": false, - "orders_invoices_credit_memos_display_grandtotal": true, + "orders_invoices_credit_memos_display_grandtotal": false, "orders_invoices_credit_memos_display_price": 987, "orders_invoices_credit_memos_display_shipping_amount": 987, - "orders_invoices_credit_memos_display_subtotal": 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", "printed_card_priceV2": Money, "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", "quickorder_active": true, - "required_character_classes_number": "xyz789", + "required_character_classes_number": "abc123", "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", + "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_url": "xyz789", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "share_active_segments": true, + "share_active_segments": false, "share_applied_cart_rule": true, "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": true, - "shopping_cart_display_price": 123, + "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": true, + "shopping_cart_display_zero_tax": false, "show_cms_breadcrumbs": 123, - "store_code": "4", + "store_code": 4, "store_group_code": "4", "store_group_name": "abc123", "store_name": "xyz789", "store_sort_order": 987, - "timezone": "xyz789", - "title_prefix": "xyz789", - "title_separator": "abc123", - "title_suffix": "abc123", - "use_store_in_url": true, + "timezone": "abc123", + "title_prefix": "abc123", + "title_separator": "xyz789", + "title_suffix": "xyz789", + "use_store_in_url": false, "website_code": "4", - "website_id": 987, + "website_id": 123, "website_name": "xyz789", - "weight_unit": "xyz789", + "weight_unit": "abc123", "welcome": "xyz789", - "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "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": "abc123" + "zero_subtotal_title": "xyz789" } } } @@ -4529,13 +4529,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](#entityurl) +**Response:** [`EntityUrl`](types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4557,7 +4557,7 @@ query urlResolver($url: String!) { ##### Variables ```json -{"url": "abc123"} +{"url": "xyz789"} ``` ##### Response @@ -4566,8 +4566,8 @@ query urlResolver($url: String!) { { "data": { "urlResolver": { - "canonical_url": "xyz789", - "entity_uid": 4, + "canonical_url": "abc123", + "entity_uid": "4", "id": 987, "redirectCode": 123, "relative_url": "xyz789", @@ -4587,7 +4587,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](#wishlistoutput) +**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) #### Example @@ -4616,8 +4616,8 @@ query wishlist { "items": [WishlistItem], "items_count": 123, "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "xyz789" + "sharing_code": "abc123", + "updated_at": "abc123" } } } 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 index 8eded2434..f9cccf6b7 100644 --- 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 @@ -8,7 +8,7 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -26,7 +26,7 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example @@ -48,7 +48,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -66,14 +66,14 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [ConfigurableProductCartItemInput] } ``` @@ -88,7 +88,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -104,14 +104,14 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [DownloadableProductCartItemInput] } ``` @@ -126,7 +126,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -144,10 +144,10 @@ Defines a new registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | #### Example @@ -158,7 +158,7 @@ Defines a new registrant. ], "email": "xyz789", "firstname": "abc123", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -172,7 +172,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -190,8 +190,8 @@ Contains details about the cart after adding products to it. | 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. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | #### Example @@ -212,16 +212,13 @@ Contains products to add to an existing compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{ - "products": ["4"], - "uid": "4" -} +{"products": ["4"], "uid": 4} ``` @@ -234,8 +231,8 @@ Contains details about the cart after adding products to it. | 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. | +| `cart` - [`Cart`](types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -256,7 +253,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -274,8 +271,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -296,14 +293,14 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { - "comment": "xyz789", + "comment": "abc123", "purchase_order_uid": 4 } ``` @@ -318,7 +315,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -336,8 +333,8 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example @@ -345,7 +342,7 @@ Defines the purchase order and cart to act on. ```json { "cart_id": "xyz789", - "purchase_order_uid": "4", + "purchase_order_uid": 4, "replace_existing_cart_items": false } ``` @@ -360,7 +357,7 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | +| `message` - [`String!`](types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example @@ -402,7 +399,7 @@ Output of the request to add items in a requisition list to the cart. | 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. | +| `cart` - [`Cart`](types-c-e.md#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 @@ -413,7 +410,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } ``` @@ -427,8 +424,8 @@ Defines a return comment. | 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. | +| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -449,7 +446,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `return` - [`Return`](types-q-s.md#return) | The modified return. | #### Example @@ -467,16 +464,16 @@ Defines tracking information to be added to the return. | 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. | +| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { - "carrier_uid": 4, - "return_uid": 4, + "carrier_uid": "4", + "return_uid": "4", "tracking_number": "xyz789" } ``` @@ -491,8 +488,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -513,8 +510,8 @@ Defines the simple and group products to add to the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example @@ -535,7 +532,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -553,14 +550,14 @@ Defines the virtual products to add to the cart. | 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_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [VirtualProductCartItemInput] } ``` @@ -575,7 +572,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -593,9 +590,9 @@ Contains the resultant wish list and any error information. | 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. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#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. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -604,7 +601,7 @@ Contains the resultant wish list and any error information. "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": true, + "status": false, "wishlist": Wishlist } ``` @@ -619,11 +616,11 @@ Contains information for each filterable option (such as price, category `UID`, | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](types-q-s.md#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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example @@ -647,17 +644,17 @@ An implementation of `AggregationOptionInterface`. | 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example ```json { "count": 123, - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -671,9 +668,9 @@ Defines aggregation option 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. | +| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -687,7 +684,7 @@ Defines aggregation option fields. { "count": 987, "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -736,26 +733,26 @@ An input object that specifies the filters used in product aggregations. | 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 | +| `code` - [`String`](types-q-s.md#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 | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": ButtonStyles, - "code": "abc123", - "is_visible": true, + "code": "xyz789", + "is_visible": false, "payment_intent": "abc123", "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "abc123", - "title": "abc123" + "title": "xyz789" } ``` @@ -769,17 +766,17 @@ Apple Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example ```json { - "payment_source": "abc123", + "payment_source": "xyz789", "payments_order_id": "abc123", - "paypal_order_id": "abc123" + "paypal_order_id": "xyz789" } ``` @@ -793,12 +790,12 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example ```json -{"code": "abc123"} +{"code": "xyz789"} ``` @@ -811,19 +808,19 @@ Contains an applied gift card with applied and remaining balance. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "applied_balance": Money, - "code": "xyz789", + "code": "abc123", "current_balance": Money, - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -837,8 +834,8 @@ Contains the applied and current balances. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](types-k-p.md#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 @@ -861,8 +858,8 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | #### Example @@ -883,7 +880,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -920,15 +917,15 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](types-q-s.md#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", + "cart_id": "xyz789", "coupon_codes": ["xyz789"], "type": "APPEND" } @@ -944,15 +941,15 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example ```json { - "cart_id": "abc123", - "gift_card_code": "abc123" + "cart_id": "xyz789", + "gift_card_code": "xyz789" } ``` @@ -966,7 +963,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -984,15 +981,15 @@ Contains applied gift cards with gift card code and amount. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](#string) | The gift card account code. | +| `applied_balance` - [`Money!`](types-k-p.md#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](types-q-s.md#string) | The gift card account code. | #### Example ```json { "applied_balance": Money, - "code": "xyz789" + "code": "abc123" } ``` @@ -1006,7 +1003,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -1024,12 +1021,12 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -1042,7 +1039,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -1060,13 +1057,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | 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. | +| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 123, "search_term": "abc123"} +{"radius": 987, "search_term": "abc123"} ``` @@ -1079,13 +1076,13 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](types-c-e.md#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} +{"compare_list": CompareList, "result": true} ``` @@ -1098,12 +1095,12 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](types-q-s.md#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. | +| `attribute_type` - [`String`](types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example @@ -1111,9 +1108,9 @@ Contains details about the attribute, including the code and type. { "attribute_code": "xyz789", "attribute_options": [AttributeOption], - "attribute_type": "abc123", + "attribute_type": "xyz789", "entity_type": "xyz789", - "input_type": "abc123", + "input_type": "xyz789", "storefront_properties": StorefrontProperties } ``` @@ -1169,16 +1166,16 @@ An input object that specifies the filters used for attributes. { "is_comparable": true, "is_filterable": true, - "is_filterable_in_search": true, + "is_filterable_in_search": false, "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_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": false, "is_wysiwyg_enabled": true, - "used_in_product_listing": false + "used_in_product_listing": true } ``` @@ -1225,15 +1222,15 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | #### Example ```json { - "attribute_code": "xyz789", - "entity_type": "abc123" + "attribute_code": "abc123", + "entity_type": "xyz789" } ``` @@ -1247,12 +1244,12 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1265,15 +1262,15 @@ Base EAV implementation of CustomAttributeMetadataInterface. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#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_class` - [`String`](types-q-s.md#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. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example @@ -1282,11 +1279,11 @@ Base EAV implementation of CustomAttributeMetadataInterface. "code": "4", "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_required": true, "is_unique": true, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -1301,7 +1298,7 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example @@ -1344,8 +1341,8 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](types-q-s.md#string) | The attribute option value. | #### Example @@ -1367,16 +1364,16 @@ Base EAV implementation of CustomAttributeOptionInterface. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example ```json { - "is_default": false, + "is_default": true, "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1388,15 +1385,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Example ```json { - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -1408,8 +1405,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1421,8 +1418,8 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -1434,14 +1431,14 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example ```json { - "code": 4, + "code": "4", "selected_options": [AttributeSelectedOptionInterface] } ``` @@ -1454,16 +1451,13 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The attribute value. | #### Example ```json -{ - "code": "4", - "value": "abc123" -} +{"code": 4, "value": "xyz789"} ``` @@ -1476,9 +1470,9 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#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. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | #### Example @@ -1486,7 +1480,7 @@ Specifies the value for attribute. { "attribute_code": "abc123", "selected_options": [AttributeInputSelectedOption], - "value": "abc123" + "value": "xyz789" } ``` @@ -1498,7 +1492,7 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1506,12 +1500,12 @@ Specifies the value for attribute. |----------------| | [`AttributeValue`](#attributevalue) | | [`AttributeSelectedOptions`](#attributeselectedoptions) | -| [`GiftCartAttributeValue`](#giftcartattributevalue) | +| [`GiftCartAttributeValue`](types-f-i.md#giftcartattributevalue) | #### Example ```json -{"code": 4} +{"code": "4"} ``` @@ -1525,7 +1519,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1547,7 +1541,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1568,8 +1562,8 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | #### Example @@ -1587,17 +1581,17 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `title` - [`String!`](types-q-s.md#string) | The payment method title. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "is_deferred": false, - "title": "abc123" + "title": "xyz789" } ``` @@ -1611,28 +1605,28 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example ```json { "amount": Money, - "available": false, + "available": true, "base_amount": Money, "carrier_code": "abc123", "carrier_title": "xyz789", "error_message": "xyz789", - "method_code": "xyz789", + "method_code": "abc123", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -1667,9 +1661,9 @@ Defines the billing address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `customer_address_uid` - [`ID`](types-f-i.md#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. | @@ -1679,9 +1673,9 @@ Defines the billing address. { "address": CartAddressInput, "customer_address_id": 987, - "customer_address_uid": 4, + "customer_address_uid": "4", "same_as_shipping": false, - "use_for_shipping": false + "use_for_shipping": true } ``` @@ -1695,23 +1689,23 @@ The billing address information | 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 | +| `address_line_1` - [`String`](types-q-s.md#string) | The first line of the address | +| `address_line_2` - [`String`](types-q-s.md#string) | The second line of the address | +| `city` - [`String`](types-q-s.md#string) | The city of the address | +| `country_code` - [`String!`](types-q-s.md#string) | The country of the address | +| `postal_code` - [`String`](types-q-s.md#string) | The postal code of the address | +| `region` - [`String`](types-q-s.md#string) | The region of the address | #### Example ```json { - "address_line_1": "xyz789", + "address_line_1": "abc123", "address_line_2": "xyz789", - "city": "xyz789", + "city": "abc123", "country_code": "abc123", "postal_code": "xyz789", - "region": "abc123" + "region": "xyz789" } ``` @@ -1725,25 +1719,25 @@ Contains details about the billing address. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](types-c-e.md#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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `customer_notes` - [`String`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example @@ -1754,20 +1748,20 @@ Contains details about the billing address. "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, - "customer_notes": "xyz789", - "fax": "abc123", - "firstname": "xyz789", + "customer_notes": "abc123", + "fax": "xyz789", + "firstname": "abc123", "id": 123, "lastname": "xyz789", "middlename": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, "street": ["xyz789"], "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "telephone": "xyz789", + "uid": 4, + "vat_id": "xyz789" } ``` @@ -1785,15 +1779,15 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `device_data` - [`String`](types-q-s.md#string) | | +| `public_hash` - [`String!`](types-q-s.md#string) | | #### Example ```json { - "device_data": "abc123", - "public_hash": "xyz789" + "device_data": "xyz789", + "public_hash": "abc123" } ``` @@ -1805,15 +1799,15 @@ The `Boolean` scalar type represents `true` or `false`. | 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. | +| `device_data` - [`String`](types-q-s.md#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. | +| `payment_method_nonce` - [`String!`](types-q-s.md#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", + "device_data": "abc123", "is_active_payment_token_enabler": true, "payment_method_nonce": "xyz789" } @@ -1827,15 +1821,15 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `device_data` - [`String`](types-q-s.md#string) | | +| `public_hash` - [`String!`](types-q-s.md#string) | | #### Example ```json { "device_data": "xyz789", - "public_hash": "abc123" + "public_hash": "xyz789" } ``` @@ -1849,22 +1843,22 @@ Contains details about an individual category that comprises a breadcrumb. | 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. | +| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](types-f-i.md#int) | The category level. | +| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | #### Example ```json { "category_id": 123, - "category_level": 987, + "category_level": 123, "category_name": "abc123", "category_uid": 4, - "category_url_key": "xyz789", + "category_url_key": "abc123", "category_url_path": "abc123" } ``` @@ -1879,24 +1873,24 @@ An implementation for bundle product cart items. | 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.)* | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#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. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1909,9 +1903,9 @@ An implementation for bundle product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": false, - "max_qty": 123.45, + "id": "xyz789", + "is_available": true, + "max_qty": 987.65, "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], @@ -1933,14 +1927,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -1948,12 +1942,12 @@ Defines bundle product options for `CreditMemoItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 + "product_sku": "abc123", + "quantity_refunded": 987.65 } ``` @@ -1967,14 +1961,14 @@ Defines bundle product options for `InvoiceItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1982,11 +1976,11 @@ Defines bundle product options for `InvoiceItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 987.65 } ``` @@ -2001,28 +1995,28 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](types-f-i.md#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 | +| `position` - [`Int`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](types-k-p.md#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. | +| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example ```json { - "option_id": 987, + "option_id": 123, "options": [BundleItemOption], "position": 123, "price_range": PriceRange, "required": true, - "sku": "xyz789", - "title": "xyz789", - "type": "abc123", + "sku": "abc123", + "title": "abc123", + "type": "xyz789", "uid": "4" } ``` @@ -2038,32 +2032,32 @@ Defines the characteristics that comprise a specific bundle item and its options | 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)* | +| `id` - [`Int`](types-f-i.md#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. | +| `label` - [`String`](types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": true, + "can_change_quantity": false, "id": 123, "is_default": true, "label": "xyz789", "position": 987, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", "product": ProductInterface, "qty": 987.65, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -2077,16 +2071,16 @@ Defines the input for a bundle option. | 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. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | #### Example ```json { "id": 123, - "quantity": 123.45, + "quantity": 987.65, "value": ["xyz789"] } ``` @@ -2101,30 +2095,30 @@ Defines bundle product options for `OrderItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -2132,26 +2126,26 @@ Defines bundle product options for `OrderItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "xyz789", + "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "product_type": "abc123", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, + "quantity_invoiced": 123.45, "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" } @@ -2167,76 +2161,76 @@ Defines basic features of a bundle product and contains multiple BundleItems. | 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. | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#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. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#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. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2245,45 +2239,45 @@ Defines basic features of a bundle product and contains multiple BundleItems. "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "xyz789", + "color": 123, + "country_of_manufacture": "abc123", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "dynamic_price": false, - "dynamic_sku": true, - "dynamic_weight": true, + "dynamic_price": true, + "dynamic_sku": false, + "dynamic_weight": false, "gift_message_available": false, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "id": 123, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "items": [BundleItem], "manufacturer": 123, - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "min_sale_qty": 123.45, + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 987.65, "name": "xyz789", - "new_from_date": "abc123", + "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price": ProductPrices, "price_details": PriceDetails, "price_range": PriceRange, "price_tiers": [TierPrice], "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 123.45, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "xyz789", "review_count": 123, @@ -2292,8 +2286,8 @@ Defines basic features of a bundle product and contains multiple BundleItems. "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, + "special_from_date": "abc123", + "special_price": 123.45, "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", @@ -2302,9 +2296,9 @@ Defines basic features of a bundle product and contains multiple BundleItems. "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", - "uid": "4", - "updated_at": "abc123", + "type_id": "xyz789", + "uid": 4, + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "abc123", @@ -2326,8 +2320,8 @@ Defines a single bundle product. | 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -2349,11 +2343,11 @@ Contains details about bundle products added to a requisition list. | 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. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2377,25 +2371,25 @@ Defines bundle product options for `ShipmentItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example ```json { "bundle_options": [ItemSelectedBundleOption], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "product_sku": "xyz789", + "quantity_shipped": 123.45 } ``` @@ -2409,25 +2403,25 @@ Defines bundle product options for `WishlistItemInterface`. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -2439,11 +2433,11 @@ Defines bundle product options for `WishlistItemInterface`. | 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 | +| `color` - [`String`](types-q-s.md#string) | The button color | +| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](types-q-s.md#string) | The button label | +| `layout` - [`String`](types-q-s.md#string) | The button layout | +| `shape` - [`String`](types-q-s.md#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 | @@ -2451,13 +2445,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "abc123", + "color": "xyz789", "height": 987, "label": "xyz789", "layout": "xyz789", "shape": "abc123", "tagline": false, - "use_default_height": false + "use_default_height": true } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md index 9b6e2e2e5..7b207e93c 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md @@ -8,14 +8,14 @@ Specifies the quote template id of the quote template to cancel | 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. | +| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "cancellation_comment": "xyz789", + "cancellation_comment": "abc123", "template_id": "4" } ``` @@ -29,14 +29,14 @@ Specifies the quote template id of the quote template to cancel | Field Name | Description | |------------|-------------| | `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" + "message": "xyz789" } ``` @@ -71,13 +71,16 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](#string) | Cancellation reason. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | #### Example ```json -{"order_id": 4, "reason": "abc123"} +{ + "order_id": "4", + "reason": "xyz789" +} ``` @@ -90,7 +93,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | | `errorV2` - [`CancelOrderError`](#cancelordererror) | | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | @@ -98,7 +101,7 @@ Contains the updated customer order and error message if any. ```json { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -112,12 +115,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](#string) | | +| `description` - [`String!`](types-q-s.md#string) | | #### Example ```json -{"description": "xyz789"} +{"description": "abc123"} ``` @@ -129,10 +132,10 @@ Contains the updated customer order and error message if any. | 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 | +| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](types-q-s.md#string) | Name on the card | #### Example @@ -154,12 +157,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `bin` - [`String`](types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "abc123"} +{"bin": "xyz789"} ``` @@ -172,8 +175,8 @@ The card payment source information | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](#string) | The name on the cardholder | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](types-q-s.md#string) | The name on the cardholder | #### Example @@ -194,17 +197,17 @@ The card payment source information | 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 | +| `brand` - [`String`](types-q-s.md#string) | The brand of the card | +| `expiry` - [`String`](types-q-s.md#string) | The expiry of the card | +| `last_digits` - [`String`](types-q-s.md#string) | The last digits of the card | #### Example ```json { - "brand": "xyz789", - "expiry": "abc123", - "last_digits": "xyz789" + "brand": "abc123", + "expiry": "xyz789", + "last_digits": "abc123" } ``` @@ -218,28 +221,28 @@ Contains the contents and other details about a guest or customer cart. | 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. | +| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](types-a-b.md#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. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#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. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -258,7 +261,7 @@ Contains the contents and other details about a guest or customer cart. "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, @@ -280,15 +283,15 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `code` - [`String!`](types-q-s.md#string) | The country code. | +| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | #### Example ```json { "code": "xyz789", - "label": "abc123" + "label": "xyz789" } ``` @@ -302,44 +305,44 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String!`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "abc123", - "company": "abc123", - "country_code": "abc123", + "city": "xyz789", + "company": "xyz789", + "country_code": "xyz789", "custom_attributes": [AttributeValueInput], "fax": "abc123", "firstname": "abc123", "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", - "prefix": "abc123", - "region": "xyz789", + "prefix": "xyz789", + "region": "abc123", "region_id": 123, - "save_in_address_book": true, + "save_in_address_book": false, "street": ["xyz789"], "suffix": "abc123", - "telephone": "xyz789", + "telephone": "abc123", "vat_id": "abc123" } ``` @@ -352,53 +355,53 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | +| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", "fax": "xyz789", "firstname": "abc123", - "id": 987, + "id": 123, "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", - "uid": "4", + "uid": 4, "vat_id": "abc123" } ``` @@ -413,17 +416,17 @@ Contains details about the region in a billing or shipping address. | 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`](types-q-s.md#string) | The state or province code. | +| `label` - [`String`](types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "code": "abc123", - "label": "xyz789", - "region_id": 123 + "label": "abc123", + "region_id": 987 } ``` @@ -437,8 +440,8 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | #### Example @@ -475,7 +478,7 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | #### Example @@ -512,20 +515,20 @@ Defines an item to be added to the cart. | 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. | +| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | #### Example ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, + "parent_sku": "abc123", + "quantity": 987.65, "selected_options": [4], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -541,28 +544,28 @@ An interface for products in a cart. |------------|-------------| | `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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | +| [`SimpleCartItem`](types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | +| [`BundleCartItem`](types-a-b.md#bundlecartitem) | +| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | #### Example @@ -573,14 +576,14 @@ An interface for products in a cart. "id": "xyz789", "is_available": true, "max_qty": 123.45, - "min_qty": 987.65, - "not_available_message": "abc123", + "min_qty": 123.45, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -594,17 +597,17 @@ Contains details about the price of the item, including taxes and discounts. | 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. | +| `catalog_discount` - [`ProductDiscount`](types-k-p.md#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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](types-k-p.md#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -634,13 +637,13 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | 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`.)* | +| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart_item_id": 123, "quantity": 123.45} +{"cart_item_id": 123, "quantity": 987.65} ``` @@ -653,9 +656,9 @@ Contains details about the price of a selected customizable value. | 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. | +| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](types-f-i.md#float) | A price value. | #### Example @@ -663,7 +666,7 @@ Contains details about the price of a selected customizable value. { "type": "FIXED", "units": "abc123", - "value": 987.65 + "value": 123.45 } ``` @@ -677,22 +680,22 @@ A single item to be updated. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | #### Example ```json { "cart_item_id": 987, - "cart_item_uid": "4", + "cart_item_uid": 4, "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, - "gift_wrapping_id": 4, + "gift_wrapping_id": "4", "quantity": 123.45 } ``` @@ -706,8 +709,8 @@ A single item to be updated. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | #### Example @@ -732,12 +735,12 @@ Contains details about the final price of items in the cart, including discount | `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. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -763,7 +766,7 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CartRule` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartRule` object. | #### Example @@ -781,15 +784,15 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | #### Example ```json { "amount": Money, - "label": "abc123" + "label": "xyz789" } ``` @@ -802,14 +805,14 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -869,29 +872,29 @@ Swatch attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](types-q-s.md#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. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example @@ -901,25 +904,25 @@ Swatch attribute metadata. "code": "4", "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_comparable": false, "is_filterable": true, "is_filterable_in_search": true, "is_html_allowed_on_front": true, - "is_required": false, + "is_required": true, "is_searchable": false, "is_unique": true, - "is_used_for_price_rules": true, - "is_used_for_promo_rules": true, + "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, + "is_wysiwyg_enabled": true, "label": "abc123", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", - "update_product_preview_image": true, - "use_product_image_for_swatch": false, + "update_product_preview_image": false, + "use_product_image_for_swatch": true, "used_in_product_listing": false } ``` @@ -934,13 +937,13 @@ Defines the filters to be used in the search. A filter contains at least one att | 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. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -966,39 +969,39 @@ Contains the full set of attributes that can be returned in a category search. | 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) | | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -1011,38 +1014,38 @@ Contains the full set of attributes that can be returned in a category search. ```json { "automatic_sorting": "xyz789", - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "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": "xyz789", - "display_mode": "abc123", - "filter_price_range": 987.65, + "description": "abc123", + "display_mode": "xyz789", + "filter_price_range": 123.45, "id": 123, "image": "abc123", - "include_in_menu": 987, + "include_in_menu": 123, "is_anchor": 987, - "landing_page": 123, - "level": 987, - "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "xyz789", - "name": "xyz789", + "landing_page": 987, + "level": 123, + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "name": "abc123", "path": "abc123", "path_in_store": "xyz789", - "position": 987, - "product_count": 987, + "position": 123, + "product_count": 123, "products": CategoryProducts, "staged": true, "uid": 4, - "updated_at": "abc123", + "updated_at": "xyz789", "url_key": "abc123", - "url_path": "xyz789", - "url_suffix": "xyz789" + "url_path": "abc123", + "url_suffix": "abc123" } ``` @@ -1056,9 +1059,9 @@ Contains details about the products assigned to a category. | 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. | +| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -1066,7 +1069,7 @@ Contains details about the products assigned to a category. { "items": [ProductInterface], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1081,8 +1084,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -1090,7 +1093,7 @@ Contains a collection of `CategoryTree` objects and pagination information. { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1104,49 +1107,49 @@ Contains the hierarchy of categories. | 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. | +| `automatic_sorting` - [`String`](types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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) | | +| `children_count` - [`String`](types-q-s.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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 | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "automatic_sorting": "xyz789", + "automatic_sorting": "abc123", "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", @@ -1154,34 +1157,34 @@ Contains the hierarchy of categories. "children_count": "abc123", "cms_block": CmsBlock, "created_at": "abc123", - "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", + "custom_layout_update_file": "xyz789", + "default_sort_by": "abc123", "description": "abc123", "display_mode": "xyz789", "filter_price_range": 987.65, - "id": 123, - "image": "xyz789", - "include_in_menu": 123, - "is_anchor": 987, + "id": 987, + "image": "abc123", + "include_in_menu": 987, + "is_anchor": 123, "landing_page": 987, - "level": 123, - "meta_description": "abc123", - "meta_keywords": "xyz789", + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "abc123", "meta_title": "xyz789", - "name": "xyz789", - "path": "xyz789", + "name": "abc123", + "path": "abc123", "path_in_store": "abc123", "position": 987, - "product_count": 987, + "product_count": 123, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "xyz789", "staged": true, "type": "CMS_PAGE", - "uid": 4, + "uid": "4", "updated_at": "xyz789", - "url_key": "xyz789", - "url_path": "xyz789", + "url_key": "abc123", + "url_path": "abc123", "url_suffix": "abc123" } ``` @@ -1196,25 +1199,25 @@ Defines details about an individual checkout agreement. | 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. | +| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](types-a-b.md#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. | +| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | #### Example ```json { - "agreement_id": 987, + "agreement_id": 123, "checkbox_text": "xyz789", "content": "abc123", - "content_height": "abc123", - "is_html": true, + "content_height": "xyz789", + "is_html": false, "mode": "AUTO", - "name": "xyz789" + "name": "abc123" } ``` @@ -1248,15 +1251,15 @@ An error encountered while adding an item to the cart. | 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 | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](types-q-s.md#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", + "message": "xyz789", "path": ["abc123"] } ``` @@ -1291,7 +1294,7 @@ Contains details about errors encountered when a customer clear cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | | `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example @@ -1329,7 +1332,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Cart` object. | #### Example @@ -1370,7 +1373,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -1386,9 +1389,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -1407,7 +1410,7 @@ Contains details about a failed close operation on a negotiable quote. | 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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1426,7 +1429,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1445,7 +1448,7 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example @@ -1463,10 +1466,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | 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 | +| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1491,9 +1494,9 @@ Contains details about a specific CMS block. | 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. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | #### Example @@ -1533,18 +1536,18 @@ Contains details about a CMS page. | 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`. | +| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example @@ -1552,13 +1555,13 @@ Contains details about a CMS page. { "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", + "identifier": "abc123", + "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" @@ -1573,12 +1576,12 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -1610,7 +1613,7 @@ Specifies which field to sort on, and whether to return the results in ascending | 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. | +| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1632,13 +1635,13 @@ Contains the output schema for a 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](types-f-i.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](types-q-s.md#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. | @@ -1646,7 +1649,7 @@ Contains the output schema for a company. | `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. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1656,12 +1659,12 @@ Contains the output schema for a company. "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "abc123", - "id": 4, + "email": "xyz789", + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "abc123", - "name": "abc123", - "payment_methods": ["abc123"], + "name": "xyz789", + "payment_methods": ["xyz789"], "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, @@ -1685,18 +1688,18 @@ Contains details about the access control list settings of a resource. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | #### Example ```json { "children": [CompanyAclResource], - "id": 4, - "sort_order": 987, - "text": "abc123" + "id": "4", + "sort_order": 123, + "text": "xyz789" } ``` @@ -1710,25 +1713,25 @@ Defines the input schema for creating a company administrator. | 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. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company administrator. | #### Example ```json { "custom_attributes": [AttributeValueInput], - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "gender": 123, + "gender": 987, "job_title": "abc123", - "lastname": "xyz789", - "telephone": "xyz789" + "lastname": "abc123", + "telephone": "abc123" } ``` @@ -1742,17 +1745,17 @@ The minimal required information to identify and display the company. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | | `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | #### Example ```json { - "id": "4", - "legal_name": "xyz789", + "id": 4, + "legal_name": "abc123", "name": "abc123", "status": "PENDING" } @@ -1769,23 +1772,23 @@ Defines the input schema for creating a new company. | 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. | +| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { "company_admin": CompanyAdminInput, - "company_email": "abc123", - "company_name": "abc123", + "company_email": "xyz789", + "company_name": "xyz789", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", - "reseller_id": "xyz789", + "legal_name": "xyz789", + "reseller_id": "abc123", "vat_tax_id": "xyz789" } ``` @@ -1800,9 +1803,9 @@ Contains company credit balances and limits. | 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. | +| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](types-k-p.md#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 @@ -1825,8 +1828,8 @@ Contains details about prior company credit operations. | 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. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1834,7 +1837,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1848,9 +1851,9 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](types-q-s.md#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. | +| `updated_by` - [`String`](types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example @@ -1858,7 +1861,7 @@ Defines a filter for narrowing the results of a credit history search. { "custom_reference_number": "abc123", "operation_type": "ALLOCATION", - "updated_by": "xyz789" + "updated_by": "abc123" } ``` @@ -1872,10 +1875,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `amount` - [`Money`](types-k-p.md#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. | +| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](types-q-s.md#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. | @@ -1923,13 +1926,13 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](types-q-s.md#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"} +{"name": "abc123", "type": "CUSTOMER"} ``` @@ -1959,16 +1962,16 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | +| `code` - [`String!`](types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "code": "abc123", - "role_id": 4, + "code": "xyz789", + "role_id": "4", "user": CompanyInvitationUserInput } ``` @@ -1983,7 +1986,7 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example @@ -2001,18 +2004,18 @@ Company user attributes in the invitation. | 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. | +| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | #### Example ```json { - "company_id": 4, - "customer_id": "4", + "company_id": "4", + "customer_id": 4, "job_title": "xyz789", "status": "ACTIVE", "telephone": "xyz789" @@ -2029,23 +2032,23 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_code": "AF", "postcode": "xyz789", "region": CustomerAddressRegion, "street": ["abc123"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2059,18 +2062,18 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](types-q-s.md#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. | +| `postcode` - [`String!`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", "postcode": "xyz789", "region": CustomerAddressRegionInput, @@ -2089,12 +2092,12 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2119,19 +2122,19 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#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. | +| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { - "id": 4, + "id": "4", "name": "xyz789", "permissions": [CompanyAclResource], - "users_count": 987 + "users_count": 123 } ``` @@ -2145,14 +2148,14 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "name": "xyz789", + "name": "abc123", "permissions": ["abc123"] } ``` @@ -2167,16 +2170,16 @@ Defines the input schema for updating a company role. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "id": "4", - "name": "abc123", + "id": 4, + "name": "xyz789", "permissions": ["xyz789"] } ``` @@ -2192,8 +2195,8 @@ Contains an array of roles. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2215,17 +2218,17 @@ Contains details about a company sales representative. | 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "abc123", - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -2296,17 +2299,13 @@ Defines an individual node in the company structure. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example ```json -{ - "entity": CompanyTeam, - "id": "4", - "parent_id": 4 -} +{"entity": CompanyTeam, "id": 4, "parent_id": 4} ``` @@ -2319,13 +2318,13 @@ Defines the input schema for updating the company structure. | 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. | +| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": 4, "tree_id": "4"} +{"parent_tree_id": "4", "tree_id": 4} ``` @@ -2338,10 +2337,10 @@ Describes a company team. | 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 | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | #### Example @@ -2364,16 +2363,16 @@ Defines the input schema for creating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { "description": "xyz789", - "name": "xyz789", + "name": "abc123", "target_id": "4" } ``` @@ -2388,17 +2387,17 @@ Defines the input schema for updating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "id": "4", - "name": "xyz789" + "name": "abc123" } ``` @@ -2412,12 +2411,12 @@ Defines the input schema for updating a company. | 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. | +| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -2426,8 +2425,8 @@ Defines the input schema for updating a company. "company_email": "xyz789", "company_name": "xyz789", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "xyz789", - "reseller_id": "xyz789", + "legal_name": "abc123", + "reseller_id": "abc123", "vat_tax_id": "xyz789" } ``` @@ -2442,14 +2441,14 @@ Defines the input schema for creating a company user. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](types-f-i.md#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. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | #### Example @@ -2458,10 +2457,10 @@ Defines the input schema for creating a company user. "email": "xyz789", "firstname": "abc123", "job_title": "abc123", - "lastname": "abc123", - "role_id": 4, + "lastname": "xyz789", + "role_id": "4", "status": "ACTIVE", - "target_id": 4, + "target_id": "4", "telephone": "abc123" } ``` @@ -2495,27 +2494,27 @@ Defines the input schema for updating a company user. | 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. | +| `email` - [`String`](types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](types-f-i.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "abc123", - "id": 4, - "job_title": "xyz789", + "id": "4", + "job_title": "abc123", "lastname": "abc123", "role_id": "4", "status": "ACTIVE", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -2530,8 +2529,8 @@ Contains details about company users. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | #### Example @@ -2571,8 +2570,8 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | #### Example @@ -2593,9 +2592,9 @@ Defines an object used to iterate through items for product comparisons. | 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. | +| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2618,16 +2617,16 @@ Contains iterable information such as the array of items, the count, and attribu | 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. | +| `item_count` - [`Int!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": "4" } @@ -2643,8 +2642,8 @@ Update the quote and complete the order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | #### Example @@ -2663,7 +2662,7 @@ Update the quote and complete the order | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | #### Example @@ -2681,10 +2680,10 @@ Contains details about a configurable product attribute option. | 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. | +| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example @@ -2707,25 +2706,25 @@ An implementation for configurable product cart items. | 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. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2739,16 +2738,16 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": true, + "id": "xyz789", + "is_available": false, "max_qty": 987.65, - "min_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, + "quantity": 123.45, "uid": 4 } ``` @@ -2763,15 +2762,15 @@ Describes configurable options that have been selected and can be selected as a | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { "attribute_code": "xyz789", - "option_value_uids": [4] + "option_value_uids": ["4"] } ``` @@ -2784,28 +2783,28 @@ Describes configurable options that have been selected and can be selected as a | 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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -2817,23 +2816,23 @@ Describes configurable options that have been selected and can be selected as a "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "abc123", + "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 987.65, + "product_url_key": "xyz789", + "quantity_canceled": 123.45, "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, - "quantity_returned": 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": "abc123" + "status": "xyz789" } ``` @@ -2847,126 +2846,126 @@ Defines basic features of a configurable product and its simple product variants | 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. | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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.)* | +| `color` - [`Int`](types-f-i.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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 | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "attribute_set_id": 123, - "canonical_url": "abc123", + "attribute_set_id": 987, + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 123, + "color": 987, "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "abc123", - "created_at": "xyz789", + "country_of_manufacture": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": false, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", "manufacturer": 987, - "max_sale_qty": 987.65, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "abc123", + "name": "xyz789", "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 987.65, - "redirect_code": 123, + "quantity": 123.45, + "rating_summary": 123.45, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": false, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, @@ -2974,8 +2973,8 @@ Defines basic features of a configurable product and its simple product variants "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": 4, - "updated_at": "abc123", + "uid": "4", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "abc123", @@ -2983,7 +2982,7 @@ Defines basic features of a configurable product and its simple product variants "url_suffix": "abc123", "variants": [ConfigurableVariant], "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -2997,8 +2996,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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) | | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](types-q-s.md#string) | | #### Example @@ -3021,16 +3020,16 @@ Contains details about configurable product options. | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](types-f-i.md#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", + "attribute_code": "abc123", "label": "abc123", "uid": "4", "values": [ConfigurableProductOptionValue] @@ -3047,21 +3046,21 @@ Defines a value for a configurable product option. | 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. | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | #### Example ```json { "is_available": true, - "is_use_default": false, + "is_use_default": true, "label": "xyz789", "swatch": SwatchDataInterface, - "uid": 4 + "uid": "4" } ``` @@ -3075,16 +3074,16 @@ Defines configurable attributes for the specified 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](types-a-b.md#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 @@ -3093,12 +3092,12 @@ Defines configurable attributes for the specified product. { "attribute_code": "xyz789", "attribute_id": "abc123", - "attribute_id_v2": 123, - "attribute_uid": 4, - "id": 123, - "label": "xyz789", + "attribute_id_v2": 987, + "attribute_uid": "4", + "id": 987, + "label": "abc123", "position": 123, - "product_id": 123, + "product_id": 987, "uid": 4, "use_default": false, "values": [ConfigurableProductOptionsValues] @@ -3116,9 +3115,9 @@ Contains metadata corresponding to the selected configurable options. | 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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#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. | +| `variant` - [`SimpleProduct`](types-q-s.md#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 @@ -3143,25 +3142,25 @@ Contains the index number assigned to a configurable product option. | 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.)* | +| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "default_label": "xyz789", - "label": "abc123", - "store_label": "xyz789", + "default_label": "abc123", + "label": "xyz789", + "store_label": "abc123", "swatch_data": SwatchDataInterface, "uid": "4", "use_default_value": true, - "value_index": 987 + "value_index": 123 } ``` @@ -3175,11 +3174,11 @@ Contains details about configurable products added to a requisition list. | 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. | +| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -3188,7 +3187,7 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` @@ -3204,7 +3203,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -3225,15 +3224,15 @@ A configurable product wish list 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -3244,8 +3243,8 @@ A configurable product wish list item. "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -3259,8 +3258,8 @@ A configurable product wish list item. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | #### Example @@ -3281,14 +3280,14 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | #### Example ```json { - "confirmation_key": "abc123", + "confirmation_key": "xyz789", "email": "abc123" } ``` @@ -3301,15 +3300,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | #### Example ```json { "confirmation_key": "abc123", - "order_id": 4 + "order_id": "4" } ``` @@ -3340,10 +3339,10 @@ List of account confirmation statuses. | 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. | +| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | #### Example @@ -3351,8 +3350,8 @@ List of account confirmation statuses. { "comment": "xyz789", "email": "abc123", - "name": "xyz789", - "telephone": "abc123" + "name": "abc123", + "telephone": "xyz789" } ``` @@ -3366,12 +3365,12 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example ```json -{"status": true} +{"status": false} ``` @@ -3384,12 +3383,12 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -3402,7 +3401,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3420,9 +3419,9 @@ Contains the source and target wish lists after copying products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3442,23 +3441,23 @@ Contains the source and target wish lists after copying products. | 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. | +| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { "available_regions": [Region], - "full_name_english": "abc123", + "full_name_english": "xyz789", "full_name_locale": "abc123", - "id": "xyz789", + "id": "abc123", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } ``` @@ -3806,12 +3805,12 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example ```json -{"products": ["4"]} +{"products": [4]} ``` @@ -3824,14 +3823,14 @@ Defines a new gift registry. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3840,9 +3839,9 @@ Defines a new gift registry. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "abc123", - "gift_registry_type_uid": "4", - "message": "abc123", + "event_name": "xyz789", + "gift_registry_type_uid": 4, + "message": "xyz789", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -3860,7 +3859,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3876,7 +3875,7 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | #### Example @@ -3910,18 +3909,18 @@ Contains the secure information used to authorize transaction. Applies to Payflo | 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. | +| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { "response_message": "abc123", - "result": 987, + "result": 123, "result_code": 123, "secure_token": "xyz789", "secure_token_id": "abc123" @@ -3938,11 +3937,11 @@ Contains payment order details that are used while processing the payment order | 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 | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example @@ -3950,9 +3949,9 @@ Contains payment order details that are used while processing the payment order { "cartId": "xyz789", "location": "PRODUCT_DETAIL", - "methodCode": "xyz789", + "methodCode": "abc123", "paymentSource": "xyz789", - "vaultIntent": false + "vaultIntent": true } ``` @@ -3966,20 +3965,20 @@ Contains payment order details that are used while processing the payment order | 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 | +| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example ```json { - "amount": 987.65, + "amount": 123.45, "currency_code": "xyz789", "id": "abc123", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "status": "abc123" } ``` @@ -3994,11 +3993,11 @@ Defines a new product review. | 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. | +| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example @@ -4006,7 +4005,7 @@ Defines a new product review. { "nickname": "abc123", "ratings": [ProductReviewRatingInput], - "sku": "xyz789", + "sku": "abc123", "summary": "xyz789", "text": "abc123" } @@ -4022,7 +4021,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | #### Example @@ -4041,7 +4040,7 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example @@ -4060,9 +4059,9 @@ Defines a set of conditions that apply to a rule. | 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. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -4085,15 +4084,15 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { - "description": "xyz789", - "name": "xyz789" + "description": "abc123", + "name": "abc123" } ``` @@ -4107,7 +4106,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -4125,14 +4124,14 @@ Describe the variables needed to create a vault payment token | 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 | +| `card_description` - [`String`](types-q-s.md#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example ```json { - "card_description": "abc123", + "card_description": "xyz789", "setup_token_id": "abc123" } ``` @@ -4147,15 +4146,15 @@ The vault token id and information about the payment source | Field Name | Description | |------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](#string) | The vault payment token information | +| `payment_source` - [`PaymentSourceOutput!`](types-k-p.md#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](types-q-s.md#string) | The vault payment token information | #### Example ```json { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } ``` @@ -4169,8 +4168,8 @@ Describe the variables needed to create a vault card setup token | Input Field | Description | |-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | +| `setup_token` - [`VaultSetupTokenInput!`](types-t-z.md#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | The 3DS mode | #### Example @@ -4191,12 +4190,12 @@ The setup token id information | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](#string) | The setup token id | +| `setup_token` - [`String!`](types-q-s.md#string) | The setup token id | #### Example ```json -{"setup_token": "xyz789"} +{"setup_token": "abc123"} ``` @@ -4209,8 +4208,8 @@ Defines the name and visibility of a new wish list. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -4228,7 +4227,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -4246,19 +4245,19 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | 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. | +| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | #### Example ```json { - "cc_exp_month": 123, - "cc_exp_year": 123, - "cc_last_4": 123, - "cc_type": "xyz789" + "cc_exp_month": 987, + "cc_exp_year": 987, + "cc_last_4": 987, + "cc_type": "abc123" } ``` @@ -4272,10 +4271,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](types-f-i.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -4285,7 +4284,7 @@ Contains credit memo details. "comments": [SalesCommentItem], "id": "4", "items": [CreditMemoItemInterface], - "number": "abc123", + "number": "xyz789", "total": CreditMemoTotal } ``` @@ -4299,12 +4298,12 @@ Contains credit memo details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -4315,7 +4314,7 @@ Contains credit memo details. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 } ``` @@ -4331,20 +4330,20 @@ Credit memo item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -4352,12 +4351,12 @@ Credit memo item details. ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -4371,15 +4370,15 @@ Contains credit memo price details. | 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. | +| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](types-k-p.md#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. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4405,26 +4404,26 @@ Contains credit memo price details. | 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 $. | +| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](types-q-s.md#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"], + "available_currency_codes": ["xyz789"], "base_currency_code": "xyz789", "base_currency_symbol": "abc123", - "default_display_currecy_code": "abc123", + "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "xyz789", "default_display_currency_code": "abc123", - "default_display_currency_symbol": "abc123", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } ``` @@ -4626,7 +4625,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | #### Example @@ -4644,31 +4643,31 @@ An interface containing fields that define the EAV attribute. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](#attributemetadata) | +| [`AttributeMetadata`](types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | #### Example ```json { "code": 4, - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", @@ -4687,15 +4686,15 @@ An interface containing fields that define the EAV attribute. | 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. | +| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | #### Example @@ -4703,7 +4702,7 @@ An interface containing fields that define the EAV attribute. { "is_default": false, "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -4719,53 +4718,53 @@ Defines the customer name, addresses, and other details. |------------|-------------| | `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. | +| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](types-t-z.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#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. | +| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the customer. | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#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. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](types-q-s.md#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). | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#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 @@ -4773,30 +4772,30 @@ Defines the customer name, addresses, and other details. { "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": "abc123", "default_billing": "xyz789", - "default_shipping": "abc123", + "default_shipping": "xyz789", "dob": "xyz789", - "email": "abc123", - "firstname": "xyz789", - "gender": 987, + "email": "xyz789", + "firstname": "abc123", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "group_id": 987, + "group_id": 123, "id": "4", - "is_subscribed": true, + "is_subscribed": false, "job_title": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -4813,10 +4812,10 @@ Defines the customer name, addresses, and other details. "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -4833,39 +4832,39 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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.)* | +| `country_id` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#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. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CustomerAddress` object. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "AF", - "country_id": "abc123", + "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 987, @@ -4875,16 +4874,16 @@ Contains detailed information about a customer's billing or shipping address. "fax": "abc123", "firstname": "abc123", "id": 987, - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["xyz789"], "suffix": "xyz789", "telephone": "xyz789", - "uid": "4", + "uid": 4, "vat_id": "abc123" } ``` @@ -4899,14 +4898,14 @@ Specifies the attribute code and value of a customer address attribute. | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "abc123" } ``` @@ -4921,15 +4920,15 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { "attribute_code": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -4943,32 +4942,32 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country_code": "AF", "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], @@ -4976,15 +4975,15 @@ Contains details about a billing or shipping address. "default_billing": true, "default_shipping": true, "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegionInput, "street": ["abc123"], "suffix": "abc123", - "telephone": "abc123", + "telephone": "xyz789", "vat_id": "abc123" } ``` @@ -4999,9 +4998,9 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -5023,17 +5022,17 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "abc123", - "region_code": "xyz789", - "region_id": 987 + "region": "xyz789", + "region_code": "abc123", + "region_id": 123 } ``` @@ -5046,8 +5045,8 @@ Defines the customer's state or province. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer addresses. | #### Example @@ -5055,7 +5054,7 @@ Defines the customer's state or province. { "items": [CustomerAddress], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5069,19 +5068,19 @@ Customer attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](types-f-i.md#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. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example @@ -5096,7 +5095,7 @@ Customer attribute metadata. "is_required": false, "is_unique": false, "label": "xyz789", - "multiline_count": 987, + "multiline_count": 123, "options": [CustomAttributeOptionInterface], "sort_order": 123, "validate_rules": [ValidationRule] @@ -5113,39 +5112,39 @@ An input object for creating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "dob": "abc123", "email": "xyz789", "firstname": "abc123", - "gender": 987, - "is_subscribed": false, - "lastname": "abc123", - "middlename": "xyz789", + "gender": 123, + "is_subscribed": true, + "lastname": "xyz789", + "middlename": "abc123", "password": "abc123", "prefix": "xyz789", - "suffix": "xyz789", - "taxvat": "xyz789" + "suffix": "abc123", + "taxvat": "abc123" } ``` @@ -5159,20 +5158,20 @@ Contains details about a single downloadable product. | 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`. | +| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { "date": "xyz789", - "download_url": "abc123", + "download_url": "xyz789", "order_increment_id": "abc123", - "remaining_downloads": "abc123", + "remaining_downloads": "xyz789", "status": "xyz789" } ``` @@ -5205,7 +5204,7 @@ Data of customer group. | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerGroup` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerGroup` object. | #### Example @@ -5223,34 +5222,34 @@ An input object that assigns or updates customer attributes. | 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). | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "dob": "abc123", "email": "abc123", - "firstname": "xyz789", - "gender": 987, - "is_subscribed": true, - "lastname": "abc123", + "firstname": "abc123", + "gender": 123, + "is_subscribed": false, + "lastname": "xyz789", "middlename": "xyz789", - "password": "xyz789", - "prefix": "abc123", - "suffix": "abc123", + "password": "abc123", + "prefix": "xyz789", + "suffix": "xyz789", "taxvat": "abc123" } ``` @@ -5265,39 +5264,39 @@ Contains details about each of the customer's orders. | 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.)* | +| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](types-k-p.md#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](types-q-s.md#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. | +| `customer_info` - [`OrderCustomerInfo!`](types-k-p.md#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `order_status_change_date` - [`String!`](types-q-s.md#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -5307,26 +5306,26 @@ Contains details about each of the customer's orders. "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "created_at": "xyz789", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, + "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_status_change_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, @@ -5334,7 +5333,7 @@ Contains details about each of the customer's orders. "shipping_address": OrderAddress, "shipping_method": "abc123", "status": "xyz789", - "token": "abc123", + "token": "xyz789", "total": OrderTotal } ``` @@ -5349,7 +5348,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](types-q-s.md#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 @@ -5387,10 +5386,10 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| -| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | +| `date_of_first_order` - [`String`](types-q-s.md#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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | #### Example @@ -5413,10 +5412,10 @@ Identifies the filter to use for filtering orders. | 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. | +| `grand_total` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filters by order status. | #### Example @@ -5457,7 +5456,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5475,12 +5474,12 @@ Customer segment details | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerSegment` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerSegment` object. | #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -5494,8 +5493,8 @@ Contains store credit information with balance and history. | 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. | +| `current_balance` - [`Money`](types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5518,8 +5517,8 @@ Lists changes to the amount of store credit available to the customer. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | #### Example @@ -5541,10 +5540,10 @@ Contains store credit history information. | 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. | +| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | #### Example @@ -5567,12 +5566,12 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | +| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | #### Example ```json -{"token": "xyz789"} +{"token": "abc123"} ``` @@ -5585,18 +5584,18 @@ An input object for updating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](types-q-s.md#string) | | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -5604,16 +5603,16 @@ An input object for updating a customer. { "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", - "dob": "abc123", - "firstname": "xyz789", + "date_of_birth": "abc123", + "dob": "xyz789", + "firstname": "abc123", "gender": 123, "is_subscribed": true, - "lastname": "xyz789", - "middlename": "abc123", - "prefix": "xyz789", + "lastname": "abc123", + "middlename": "xyz789", + "prefix": "abc123", "suffix": "xyz789", - "taxvat": "abc123" + "taxvat": "xyz789" } ``` @@ -5627,12 +5626,12 @@ Contains information about a text area that is defined as part of a customizable | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example @@ -5640,10 +5639,10 @@ Contains information about a text area that is defined as part of a customizable ```json { "option_id": 123, - "product_sku": "xyz789", - "required": true, - "sort_order": 123, - "title": "xyz789", + "product_sku": "abc123", + "required": false, + "sort_order": 987, + "title": "abc123", "uid": 4, "value": CustomizableAreaValue } @@ -5659,20 +5658,20 @@ Defines the price and sku of a product whose page contains a customized text are | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { "max_characters": 123, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "uid": "4" } ``` @@ -5687,11 +5686,11 @@ Contains information about a set of checkbox values that are defined as part of | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example @@ -5699,9 +5698,9 @@ Contains information about a set of checkbox values that are defined as part of ```json { "option_id": 987, - "required": true, - "sort_order": 123, - "title": "abc123", + "required": false, + "sort_order": 987, + "title": "xyz789", "uid": "4", "value": [CustomizableCheckboxValue] } @@ -5717,13 +5716,13 @@ Defines the price and sku of a product whose page contains a customized set of c | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example @@ -5732,10 +5731,10 @@ Defines the price and sku of a product whose page contains a customized set of c "option_type_id": 987, "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "sort_order": 123, - "title": "xyz789", - "uid": "4" + "title": "abc123", + "uid": 4 } ``` @@ -5749,24 +5748,24 @@ Contains information about a date picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": 123, - "product_sku": "abc123", + "option_id": 987, + "product_sku": "xyz789", "required": false, "sort_order": 987, "title": "xyz789", - "uid": 4, + "uid": "4", "value": CustomizableDateValue } ``` @@ -5801,17 +5800,17 @@ Defines the price and sku of a product whose page contains a customized date pic | 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. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", "type": "DATE", @@ -5829,22 +5828,22 @@ Contains information about a drop down menu that is defined as part of a customi | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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, + "option_id": 123, + "required": false, "sort_order": 123, "title": "xyz789", - "uid": "4", + "uid": 4, "value": [CustomizableDropDownValue] } ``` @@ -5859,25 +5858,25 @@ Defines the price and sku of a product whose page contains a customized drop dow | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "option_type_id": 987, - "price": 123.45, + "option_type_id": 123, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 987, - "title": "xyz789", - "uid": 4 + "title": "abc123", + "uid": "4" } ``` @@ -5891,12 +5890,12 @@ Contains information about a text field that is defined as part of a customizabl | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example @@ -5904,11 +5903,11 @@ Contains information about a text field that is defined as part of a customizabl ```json { "option_id": 987, - "product_sku": "abc123", - "required": false, + "product_sku": "xyz789", + "required": true, "sort_order": 123, - "title": "xyz789", - "uid": 4, + "title": "abc123", + "uid": "4", "value": CustomizableFieldValue } ``` @@ -5923,21 +5922,21 @@ Defines the price and sku of a product whose page contains a customized text fie | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { - "max_characters": 987, + "max_characters": 123, "price": 123.45, "price_type": "FIXED", - "sku": "abc123", - "uid": "4" + "sku": "xyz789", + "uid": 4 } ``` @@ -5951,12 +5950,12 @@ Contains information about a file picker that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -5967,8 +5966,8 @@ Contains information about a file picker that is defined as part of a customizab "product_sku": "xyz789", "required": true, "sort_order": 987, - "title": "xyz789", - "uid": "4", + "title": "abc123", + "uid": 4, "value": CustomizableFileValue } ``` @@ -5983,22 +5982,22 @@ Defines the price and sku of a product whose page contains a customized file pic | 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. | +| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { "file_extension": "xyz789", - "image_size_x": 987, - "image_size_y": 987, - "price": 987.65, + "image_size_x": 123, + "image_size_y": 123, + "price": 123.45, "price_type": "FIXED", "sku": "xyz789", "uid": 4 @@ -6015,11 +6014,11 @@ Contains information about a multiselect that is defined as part of a customizab | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example @@ -6028,8 +6027,8 @@ Contains information about a multiselect that is defined as part of a customizab { "option_id": 987, "required": true, - "sort_order": 987, - "title": "abc123", + "sort_order": 123, + "title": "xyz789", "uid": 4, "value": [CustomizableMultipleValue] } @@ -6045,24 +6044,24 @@ Defines the price and sku of a product whose page contains a customized multisel | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { "option_type_id": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "xyz789", + "sku": "xyz789", + "sort_order": 123, + "title": "abc123", "uid": "4" } ``` @@ -6077,17 +6076,17 @@ Defines a customizable 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. | +| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | #### Example ```json { - "id": 123, - "uid": 4, - "value_string": "xyz789" + "id": 987, + "uid": "4", + "value_string": "abc123" } ``` @@ -6101,11 +6100,11 @@ Contains basic information about a customizable option. It can be implemented by | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -6124,11 +6123,11 @@ Contains basic information about a customizable option. It can be implemented by ```json { - "option_id": 987, - "required": false, + "option_id": 123, + "required": true, "sort_order": 123, "title": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -6148,12 +6147,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | | [`ConfigurableProduct`](#configurableproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | #### Example @@ -6171,11 +6170,11 @@ Contains information about a set of radio buttons that are defined as part of a | 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. | +| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example @@ -6183,10 +6182,10 @@ Contains information about a set of radio buttons that are defined as part of a ```json { "option_id": 987, - "required": true, + "required": false, "sort_order": 123, - "title": "xyz789", - "uid": 4, + "title": "abc123", + "uid": "4", "value": [CustomizableRadioValue] } ``` @@ -6201,24 +6200,24 @@ Defines the price and sku of a product whose page contains a customized set of r | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "option_type_id": 987, - "price": 123.45, + "option_type_id": 123, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "abc123", + "sku": "xyz789", + "sort_order": 123, + "title": "xyz789", "uid": 4 } ``` @@ -6233,7 +6232,7 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example @@ -6251,12 +6250,12 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -6269,12 +6268,12 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -6287,12 +6286,12 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example ```json -{"result": true} +{"result": false} ``` @@ -6303,9 +6302,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -6324,7 +6323,7 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -6343,7 +6342,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -6362,12 +6361,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -6378,7 +6377,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example @@ -6396,9 +6395,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -6423,7 +6422,7 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example @@ -6444,13 +6443,13 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | +| `message` - [`String`](types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"message": "abc123", "type": "UNDEFINED"} +{"message": "xyz789", "type": "UNDEFINED"} ``` @@ -6480,7 +6479,7 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example @@ -6516,7 +6515,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6534,8 +6533,8 @@ Indicates whether the request to delete the requisition list was successful. | 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. | +| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example @@ -6553,8 +6552,8 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example @@ -6572,13 +6571,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6589,8 +6588,8 @@ Specifies the discount type and value for quote line item. "coupon": AppliedCoupon, "is_discounting_locked": true, "label": "xyz789", - "type": "abc123", - "value": 987.65 + "type": "xyz789", + "value": 123.45 } ``` @@ -6604,22 +6603,22 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#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. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -6632,13 +6631,13 @@ An implementation for downloadable product cart items. "is_available": false, "links": [DownloadableProductLinks], "max_qty": 987.65, - "min_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, + "quantity": 123.45, "samples": [DownloadableProductSamples], "uid": 4 } @@ -6656,12 +6655,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -6671,10 +6670,10 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` @@ -6707,12 +6706,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6720,12 +6719,12 @@ Defines downloadable product options for `InvoiceItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -6739,17 +6738,17 @@ Defines characteristics of the links for downloadable product. | 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. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json { - "sort_order": 987, - "title": "abc123", - "uid": "4" + "sort_order": 123, + "title": "xyz789", + "uid": 4 } ``` @@ -6765,27 +6764,27 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -6793,7 +6792,7 @@ Defines downloadable product options for `OrderItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -6804,13 +6803,13 @@ Defines downloadable product options for `OrderItemInterface`. "product_sale_price": Money, "product_sku": "abc123", "product_type": "abc123", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, + "quantity_invoiced": 987.65, "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" @@ -6827,72 +6826,72 @@ Defines a product that the shopper downloads. | 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. | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#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.)* | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | #### Example @@ -6901,9 +6900,9 @@ Defines a product that the shopper downloads. "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], - "color": 123, + "color": 987, "country_of_manufacture": "xyz789", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -6913,58 +6912,58 @@ Defines a product that the shopper downloads. "downloadable_product_samples": [ DownloadableProductSamples ], - "gift_message_available": false, - "gift_wrapping_available": true, + "gift_message_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "links_purchased_separately": 123, - "links_title": "xyz789", - "manufacturer": 123, + "links_title": "abc123", + "manufacturer": 987, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "rating_summary": 123.45, "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 987.65, "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", - "uid": 4, - "updated_at": "abc123", + "type_id": "abc123", + "uid": "4", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", - "url_path": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website] @@ -7007,32 +7006,32 @@ Defines characteristics of a downloadable product. | 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.)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](types-a-b.md#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)* | +| `number_of_downloads` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { - "id": 123, - "is_shareable": true, + "id": 987, + "is_shareable": false, "link_type": "FILE", - "number_of_downloads": 123, - "price": 987.65, + "number_of_downloads": 987, + "price": 123.45, "sample_file": "abc123", "sample_type": "FILE", "sample_url": "abc123", "sort_order": 987, - "title": "xyz789", + "title": "abc123", "uid": 4 } ``` @@ -7047,12 +7046,12 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example ```json -{"link_id": 123} +{"link_id": 987} ``` @@ -7065,12 +7064,12 @@ Defines characteristics of a downloadable product. | 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)* | +| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](types-q-s.md#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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | #### Example @@ -7079,9 +7078,9 @@ Defines characteristics of a downloadable product. "id": 123, "sample_file": "xyz789", "sample_type": "FILE", - "sample_url": "xyz789", + "sample_url": "abc123", "sort_order": 123, - "title": "abc123" + "title": "xyz789" } ``` @@ -7095,12 +7094,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -7111,7 +7110,7 @@ Contains details about downloadable products added to a requisition list. "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": "4" + "uid": 4 } ``` @@ -7125,22 +7124,22 @@ A downloadable product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": "4", "links_v2": [DownloadableProductLinks], "product": ProductInterface, @@ -7159,14 +7158,14 @@ Identifies a quote to be duplicated | 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. | +| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | #### Example ```json { - "duplicated_quote_uid": "4", + "duplicated_quote_uid": 4, "quote_uid": "4" } ``` @@ -7181,7 +7180,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -7200,12 +7199,15 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json -{"content": ComplexTextValue, "uid": 4} +{ + "content": ComplexTextValue, + "uid": "4" +} ``` @@ -7261,8 +7263,8 @@ Contains an array of dynamic blocks. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -7284,14 +7286,18 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](types-f-i.md#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"} +{ + "dynamic_block_uids": ["4"], + "locations": ["CONTENT"], + "type": "SPECIFIED" +} ``` @@ -7304,15 +7310,15 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | +| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | #### Example ```json { "attribute_code": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -7326,8 +7332,8 @@ Defines a customer-entered option. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | #### Example @@ -7348,21 +7354,21 @@ Contains the `uid`, `relative_url`, and `type` attributes. | 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. | +| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "canonical_url": "abc123", - "entity_uid": "4", - "id": 123, - "redirectCode": 987, + "canonical_url": "xyz789", + "entity_uid": 4, + "id": 987, + "redirectCode": 123, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -7379,21 +7385,21 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Possible Types | Error Types | |----------------| | [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](#insufficientstockerror) | +| [`InsufficientStockError`](types-f-i.md#insufficientstockerror) | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -7405,20 +7411,20 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -7432,7 +7438,7 @@ Contains details about an address. | 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. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -7440,7 +7446,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput } ``` @@ -7454,8 +7460,8 @@ Contains details about an address. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example @@ -7514,7 +7520,7 @@ Contains customer token for external customer. | Field Name | Description | |------------|-------------| | `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | -| `token` - [`String!`](#string) | The customer authorization token. | +| `token` - [`String!`](types-q-s.md#string) | The customer authorization token. | #### Example @@ -7535,13 +7541,13 @@ Lists the exchange rate. | 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. | +| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "abc123", "rate": 123.45} +{"currency_to": "abc123", "rate": 987.65} ``` @@ -7554,10 +7560,10 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` 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 1f2c8712e..32ff0d1b3 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 @@ -6,27 +6,27 @@ | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "code": "xyz789", + "code": "abc123", "is_visible": false, - "payment_intent": "xyz789", + "payment_intent": "abc123", "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" } ``` @@ -40,15 +40,15 @@ Fastlane Payment inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `paypal_fastlane_token` - [`String`](types-q-s.md#string) | The single use token from Fastlane | #### Example ```json { "payment_source": "abc123", - "paypal_fastlane_token": "xyz789" + "paypal_fastlane_token": "abc123" } ``` @@ -62,15 +62,15 @@ Defines a filter that matches the input exactly. | 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"]`. | +| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"] + "in": ["abc123"] } ``` @@ -101,13 +101,13 @@ Defines a filter that performs a fuzzy search. | 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` - [`String`](types-q-s.md#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"} +{"match": "xyz789", "match_type": "FULL"} ``` @@ -120,8 +120,8 @@ Defines a filter that matches a range of values, such as prices or dates. | 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. | +| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example @@ -142,9 +142,9 @@ Defines a filter for an input string. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example @@ -152,7 +152,7 @@ Defines a filter for an input string. { "eq": "abc123", "in": ["xyz789"], - "match": "abc123" + "match": "xyz789" } ``` @@ -166,41 +166,41 @@ Defines the comparison operators that can be used in a filter. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](types-q-s.md#string) | | +| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](types-q-s.md#string) | Less than. | +| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](types-q-s.md#string) | Not null. | +| `null` - [`String`](types-q-s.md#string) | Is null. | +| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { "eq": "abc123", - "finset": ["xyz789"], - "from": "abc123", + "finset": ["abc123"], + "from": "xyz789", "gt": "abc123", - "gteq": "abc123", - "in": ["abc123"], - "like": "abc123", + "gteq": "xyz789", + "in": ["xyz789"], + "like": "xyz789", "lt": "abc123", "lteq": "abc123", - "moreq": "xyz789", - "neq": "abc123", - "nin": ["xyz789"], - "notnull": "xyz789", + "moreq": "abc123", + "neq": "xyz789", + "nin": ["abc123"], + "notnull": "abc123", "null": "xyz789", - "to": "xyz789" + "to": "abc123" } ``` @@ -214,8 +214,8 @@ A single FPT that can be applied to a product price. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example @@ -272,7 +272,7 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example @@ -290,12 +290,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | +| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "xyz789"} +{"customer_token": "abc123"} ``` @@ -331,7 +331,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": 4} +{"negotiable_quote_uid": "4"} ``` @@ -344,7 +344,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -362,9 +362,9 @@ Contains details about the gift card account. | 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. | +| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -372,7 +372,7 @@ Contains details about the gift card account. { "balance": Money, "code": "xyz789", - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -386,7 +386,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | #### Example @@ -418,7 +418,7 @@ Contains the value of a gift card, the website that generated the card, and rela "attribute_id": 987, "uid": 4, "value": 123.45, - "value_id": 123, + "value_id": 987, "website_id": 123, "website_value": 987.65 } @@ -434,28 +434,28 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `amount` - [`Money!`](types-k-p.md#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 | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#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. | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#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. | +| `message` - [`String`](types-q-s.md#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. | +| `not_available_message` - [`String`](types-q-s.md#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. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#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. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -469,7 +469,7 @@ Contains details about a gift card that has been added to a cart. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", + "id": "xyz789", "is_available": true, "max_qty": 123.45, "message": "abc123", @@ -479,12 +479,12 @@ Contains details about a gift card that has been added to a cart. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "recipient_email": "abc123", + "quantity": 123.45, + "recipient_email": "xyz789", "recipient_name": "abc123", "sender_email": "abc123", - "sender_name": "abc123", - "uid": "4" + "sender_name": "xyz789", + "uid": 4 } ``` @@ -496,13 +496,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -511,12 +511,12 @@ Contains details about a gift card that has been added to a cart. { "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -528,13 +528,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -545,7 +545,7 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "quantity_invoiced": 123.45 @@ -562,11 +562,11 @@ Contains details about a gift card. | 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. | +| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example @@ -574,9 +574,9 @@ Contains details about a gift card. { "message": "xyz789", "recipient_email": "xyz789", - "recipient_name": "abc123", - "sender_email": "xyz789", - "sender_name": "xyz789" + "recipient_name": "xyz789", + "sender_email": "abc123", + "sender_name": "abc123" } ``` @@ -590,13 +590,13 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -606,9 +606,9 @@ Contains details about the sender, recipient, and amount of a gift card. "custom_giftcard_amount": Money, "message": "abc123", "recipient_email": "xyz789", - "recipient_name": "xyz789", + "recipient_name": "abc123", "sender_email": "xyz789", - "sender_name": "abc123" + "sender_name": "xyz789" } ``` @@ -620,20 +620,20 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#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. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#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. | @@ -641,8 +641,8 @@ Contains details about the sender, recipient, and amount of a gift card. | `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. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -654,20 +654,20 @@ Contains details about the sender, recipient, and amount of a gift card. "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "product_type": "abc123", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, + "quantity_ordered": 987.65, + "quantity_refunded": 123.45, "quantity_return_requested": 123.45, - "quantity_returned": 987.65, + "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" @@ -684,123 +684,123 @@ Defines properties of a gift card. | 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. | +| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](types-a-b.md#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. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](types-q-s.md#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.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#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. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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. | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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.)* | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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, + "allow_message": false, + "allow_open_amount": true, "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 987, + "color": 123, "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_message_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", - "id": 987, + "id": 123, "image": ProductImage, - "is_redeemable": true, - "is_returnable": "xyz789", + "is_redeemable": false, + "is_returnable": "abc123", "lifetime": 987, - "manufacturer": 987, + "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 123, + "message_max_length": 987, "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, + "new_from_date": "xyz789", + "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", + "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -809,30 +809,30 @@ Defines properties of a gift card. "rating_summary": 123.45, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, + "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": "xyz789", + "special_price": 123.45, + "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": 4, + "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "abc123", + "url_key": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website], "weight": 987.65 } @@ -848,9 +848,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -861,8 +861,8 @@ Contains details about gift cards added to a requisition list. "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -876,10 +876,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -887,7 +887,7 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -926,25 +926,25 @@ A single gift card added to a wish list. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "gift_card_options": GiftCardOptions, - "id": 4, + "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -959,12 +959,15 @@ Gift card custom attribute value containing array data. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The attribute code. | -| `options` - [`[String]!`](#string) | Array of gift card attribute option values. | +| `options` - [`[String]!`](types-q-s.md#string) | Array of gift card attribute option values. | #### Example ```json -{"code": 4, "options": ["xyz789"]} +{ + "code": "4", + "options": ["abc123"] +} ``` @@ -977,9 +980,9 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | +| `from` - [`String!`](types-q-s.md#string) | Sender name | +| `message` - [`String!`](types-q-s.md#string) | Gift message text | +| `to` - [`String!`](types-q-s.md#string) | Recipient name | #### Example @@ -987,7 +990,7 @@ Contains the text of a gift message, its sender, and recipient { "from": "xyz789", "message": "abc123", - "to": "xyz789" + "to": "abc123" } ``` @@ -1001,17 +1004,17 @@ Defines a gift message. | 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. | +| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | #### Example ```json { - "from": "xyz789", + "from": "abc123", "message": "abc123", - "to": "abc123" + "to": "xyz789" } ``` @@ -1025,12 +1028,12 @@ Contains prices for gift wrapping options. | 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. | +| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](types-k-p.md#money) | Price for the printed card including tax. | #### Example @@ -1055,15 +1058,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `event_name` - [`String!`](types-q-s.md#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. | +| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](types-q-s.md#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. | +| `shipping_address` - [`CustomerAddress`](types-c-e.md#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. | @@ -1074,16 +1077,16 @@ Contains details about a gift registry. { "created_at": "xyz789", "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "xyz789", + "message": "abc123", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } ``` @@ -1097,8 +1100,8 @@ Contains details about a gift registry. |------------|-------------| | `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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example @@ -1106,8 +1109,8 @@ Contains details about a gift registry. { "code": 4, "group": "EVENT_INFORMATION", - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -1145,15 +1148,12 @@ Defines a dynamic attribute. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example ```json -{ - "code": "4", - "value": "xyz789" -} +{"code": 4, "value": "xyz789"} ``` @@ -1165,8 +1165,8 @@ Defines a dynamic attribute. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1193,11 +1193,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Example @@ -1207,7 +1207,7 @@ Defines a dynamic attribute. "attribute_group": "xyz789", "code": 4, "input_type": "xyz789", - "is_required": false, + "is_required": true, "label": "xyz789", "sort_order": 987 } @@ -1221,11 +1221,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1238,8 +1238,8 @@ Defines a dynamic attribute. ```json { - "attribute_group": "abc123", - "code": 4, + "attribute_group": "xyz789", + "code": "4", "input_type": "abc123", "is_required": true, "label": "abc123", @@ -1255,9 +1255,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1266,11 +1266,11 @@ Defines a dynamic attribute. ```json { - "created_at": "xyz789", - "note": "xyz789", + "created_at": "abc123", + "note": "abc123", "product": ProductInterface, - "quantity": 987.65, - "quantity_fulfilled": 123.45, + "quantity": 123.45, + "quantity_fulfilled": 987.65, "uid": "4" } ``` @@ -1283,9 +1283,9 @@ Defines a dynamic attribute. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](types-k-p.md#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. | @@ -1300,12 +1300,12 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", + "created_at": "xyz789", "note": "abc123", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 987.65, - "uid": "4" + "quantity_fulfilled": 123.45, + "uid": 4 } ``` @@ -1319,14 +1319,14 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](types-a-b.md#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) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1350,7 +1350,7 @@ Contains details about an error that occurred when processing a gift registry it | `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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1359,8 +1359,8 @@ Contains details about an error that occurred when processing a gift registry it { "code": "OUT_OF_STOCK", "gift_registry_item_uid": "4", - "gift_registry_uid": "4", - "message": "abc123", + "gift_registry_uid": 4, + "message": "xyz789", "product_uid": 4 } ``` @@ -1401,7 +1401,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1439,9 +1439,9 @@ Contains details about a registrant. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1451,8 +1451,8 @@ Contains details about a registrant. "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "abc123", - "firstname": "abc123", + "email": "xyz789", + "firstname": "xyz789", "lastname": "xyz789", "uid": "4" } @@ -1467,15 +1467,15 @@ Contains details about a registrant. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { "code": "4", - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -1490,12 +1490,12 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | +| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](types-q-s.md#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. | +| `location` - [`String`](types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](types-q-s.md#string) | The type of event being held. | #### Example @@ -1504,9 +1504,9 @@ Contains the results of a gift registry search. "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": "4", - "location": "abc123", + "location": "xyz789", "name": "abc123", - "type": "xyz789" + "type": "abc123" } ``` @@ -1520,7 +1520,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](types-c-e.md#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. | @@ -1564,7 +1564,7 @@ Contains details about a gift registry type. | 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. | +| `label` - [`String!`](types-q-s.md#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 @@ -1575,7 +1575,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1589,18 +1589,18 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `design` - [`String!`](types-q-s.md#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. | +| `price` - [`Money!`](types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example ```json { - "design": "abc123", - "id": 4, + "design": "xyz789", + "id": "4", "image": GiftWrappingImage, "price": Money, "uid": "4" @@ -1617,15 +1617,15 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | #### Example ```json { - "label": "xyz789", - "url": "xyz789" + "label": "abc123", + "url": "abc123" } ``` @@ -1637,17 +1637,17 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](#string) | The button color | +| `color` - [`String`](types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | +| `type` - [`String`](types-q-s.md#string) | The button type | #### Example ```json { - "color": "xyz789", - "height": 987, - "type": "xyz789" + "color": "abc123", + "height": 123, + "type": "abc123" } ``` @@ -1660,14 +1660,14 @@ Points to an image associated with a gift wrapping option. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -1677,7 +1677,7 @@ Points to an image associated with a gift wrapping option. "code": "abc123", "is_visible": false, "payment_intent": "xyz789", - "payment_source": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", @@ -1695,17 +1695,17 @@ Google Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example ```json { "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123" + "payments_order_id": "abc123", + "paypal_order_id": "xyz789" } ``` @@ -1720,67 +1720,67 @@ Defines a grouped product, which consists of simple standalone products that are | 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. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#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. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#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.)* | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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.)* | +| `tier_prices` - [`[ProductTierPrices]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](types-q-s.md#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.)* | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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 @@ -1788,15 +1788,15 @@ Defines a grouped product, which consists of simple standalone products that are ```json { "attribute_set_id": 123, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 123, + "color": 987, "country_of_manufacture": "abc123", "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, + "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, "id": 123, @@ -1804,36 +1804,36 @@ Defines a grouped product, which consists of simple standalone products that are "is_returnable": "xyz789", "items": [GroupedProductItem], "manufacturer": 123, - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_description": "xyz789", + "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": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, - "options_container": "xyz789", + "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, "rating_summary": 123.45, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 987.65, - "special_to_date": "xyz789", - "staged": false, + "special_to_date": "abc123", + "staged": true, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, @@ -1844,8 +1844,8 @@ Defines a grouped product, which consists of simple standalone products that are "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "xyz789", + "url_key": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website], @@ -1864,7 +1864,7 @@ Contains information about an individual grouped product item. | 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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example @@ -1887,11 +1887,11 @@ A grouped product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -1900,7 +1900,7 @@ A grouped product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": 4, "product": ProductInterface, "quantity": 123.45 @@ -1917,14 +1917,14 @@ Input to retrieve a guest order based on token. | Input Field | Description | |-------------|-------------| -| `reason` - [`String!`](#string) | Cancellation reason. | -| `token` - [`String!`](#string) | Order token. | +| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | +| `token` - [`String!`](types-q-s.md#string) | Order token. | #### Example ```json { - "reason": "xyz789", + "reason": "abc123", "token": "xyz789" } ``` @@ -1939,16 +1939,16 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `lastname` - [`String!`](#string) | Order billing address lastname. | -| `number` - [`String!`](#string) | Order number. | +| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | +| `lastname` - [`String!`](types-q-s.md#string) | Order billing address lastname. | +| `number` - [`String!`](types-q-s.md#string) | Order number. | #### Example ```json { - "email": "abc123", - "lastname": "xyz789", + "email": "xyz789", + "lastname": "abc123", "number": "xyz789" } ``` @@ -1961,35 +1961,35 @@ Input to retrieve an order based on details. | 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 | +| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](types-a-b.md#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "cc_vault_code": "xyz789", + "cc_vault_code": "abc123", "code": "abc123", "is_vault_enabled": false, "is_visible": true, - "payment_intent": "abc123", - "payment_source": "abc123", + "payment_intent": "xyz789", + "payment_source": "xyz789", "requires_card_details": false, "sdk_params": [SDKParams], - "sort_order": "abc123", - "three_ds": true, + "sort_order": "xyz789", + "three_ds": false, "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" } ``` @@ -2003,15 +2003,15 @@ Hosted Fields payment inputs | 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 | +| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example @@ -2020,12 +2020,12 @@ Hosted Fields payment inputs "cardBin": "xyz789", "cardExpiryMonth": "xyz789", "cardExpiryYear": "xyz789", - "cardLast4": "abc123", + "cardLast4": "xyz789", "holderName": "abc123", - "is_active_payment_token_enabler": true, - "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123" + "is_active_payment_token_enabler": false, + "payment_source": "abc123", + "payments_order_id": "abc123", + "paypal_order_id": "xyz789" } ``` @@ -2039,8 +2039,8 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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 @@ -2061,12 +2061,12 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | #### Example ```json -{"secure_form_url": "xyz789"} +{"secure_form_url": "abc123"} ``` @@ -2079,7 +2079,7 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example @@ -2097,15 +2097,15 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | +| `name` - [`String`](types-q-s.md#string) | A parameter name. | +| `value` - [`String`](types-q-s.md#string) | A parameter value. | #### Example ```json { - "name": "abc123", - "value": "abc123" + "name": "xyz789", + "value": "xyz789" } ``` @@ -2133,8 +2133,8 @@ When expected as an input type, any string (such as `"4"`) or integer | 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. | +| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -2175,8 +2175,8 @@ List of templates/filters applied to customer attribute input. | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `code` - [`CartUserInputErrorType!`](types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `quantity` - [`Float`](#float) | Amount of available stock | #### Example @@ -2184,7 +2184,7 @@ List of templates/filters applied to customer attribute input. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123", + "message": "xyz789", "quantity": 987.65 } ``` @@ -2212,7 +2212,7 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example @@ -2230,10 +2230,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#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. | +| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2241,7 +2241,7 @@ Contains invoice details. ```json { "comments": [SalesCommentItem], - "id": "4", + "id": 4, "items": [InvoiceItemInterface], "number": "abc123", "total": InvoiceTotal @@ -2256,12 +2256,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2269,7 +2269,7 @@ Contains invoice details. ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -2288,20 +2288,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2310,7 +2310,7 @@ Contains detailes about invoiced items. ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -2329,14 +2329,14 @@ Contains price details from an invoice. | 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. | +| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2363,12 +2363,12 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2381,12 +2381,12 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2399,7 +2399,7 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example @@ -2417,12 +2417,12 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2435,7 +2435,7 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example @@ -2453,11 +2453,11 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](types-q-s.md#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` - [`String`](types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example @@ -2467,7 +2467,7 @@ The note object for quote line item. "created_at": "xyz789", "creator_id": 123, "creator_type": 987, - "negotiable_quote_item_uid": 4, + "negotiable_quote_item_uid": "4", "note": "xyz789", "note_uid": 4 } @@ -2484,7 +2484,7 @@ A list of options of the selected bundle product. | 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. | +| `label` - [`String!`](types-q-s.md#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. | @@ -2494,7 +2494,7 @@ A list of options of the selected bundle product. { "id": 4, "label": "xyz789", - "uid": "4", + "uid": 4, "values": [ItemSelectedBundleOptionValue] } ``` @@ -2510,9 +2510,9 @@ A list of values for the selected bundle product. | 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. | +| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](types-q-s.md#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. | @@ -2520,11 +2520,11 @@ A list of values for the selected bundle product. ```json { - "id": "4", + "id": 4, "price": Money, - "product_name": "xyz789", + "product_name": "abc123", "product_sku": "abc123", - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md index c630b8e73..f4c849074 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md @@ -8,8 +8,8 @@ Contains a key-value pair. | 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. | +| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | #### Example @@ -31,17 +31,17 @@ Contains information for rendering layered navigation. | 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.)* | +| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](types-q-s.md#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", + "filter_items_count": 123, + "name": "abc123", "request_var": "xyz789" } ``` @@ -54,15 +54,15 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example ```json { - "items_count": 987, + "items_count": 123, "label": "xyz789", "value_string": "xyz789" } @@ -76,24 +76,24 @@ Contains information for rendering layered navigation. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](types-q-s.md#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) | +| [`SwatchLayerFilterItem`](types-q-s.md#swatchlayerfilteritem) | #### Example ```json { - "items_count": 123, + "items_count": 987, "label": "xyz789", - "value_string": "abc123" + "value_string": "xyz789" } ``` @@ -107,16 +107,16 @@ Sets quote item note. | 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. | +| `note` - [`String`](types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "note": "xyz789", - "quote_item_uid": "4", + "note": "abc123", + "quote_item_uid": 4, "quote_uid": "4" } ``` @@ -132,14 +132,14 @@ Defines characteristics about images and videos associated with a specific produ | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -147,14 +147,14 @@ Defines characteristics about images and videos associated with a specific produ ```json { "content": ProductMediaGalleryEntriesContent, - "disabled": true, + "disabled": false, "file": "xyz789", "id": 987, "label": "abc123", - "media_type": "xyz789", + "media_type": "abc123", "position": 987, "types": ["xyz789"], - "uid": 4, + "uid": "4", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -169,11 +169,11 @@ Contains basic information about a product image or video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -186,10 +186,10 @@ Contains basic information about a product image or video. ```json { - "disabled": false, - "label": "abc123", - "position": 987, - "types": ["xyz789"], + "disabled": true, + "label": "xyz789", + "position": 123, + "types": ["abc123"], "url": "xyz789" } ``` @@ -202,12 +202,12 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{"type": "abc123"} +{"type": "xyz789"} ``` @@ -218,14 +218,14 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `layout` - [`String`](#string) | The message layout | +| `layout` - [`String`](types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "layout": "xyz789", + "layout": "abc123", "logo": MessageStyleLogo } ``` @@ -240,13 +240,13 @@ Defines a monetary value, including a numeric value and a currency code. | 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. | +| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | #### Example ```json -{"currency": "AFN", "value": 123.45} +{"currency": "AFN", "value": 987.65} ``` @@ -259,9 +259,9 @@ Contains the customer's gift registry and any errors encountered. | 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. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -283,12 +283,12 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -301,8 +301,8 @@ Output of the request to move items to another requisition list. | 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. | +| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -323,17 +323,17 @@ Move Line Item to Requisition List. | 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. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json { "quote_item_uid": "4", - "quote_uid": 4, - "requisition_list_uid": 4 + "quote_uid": "4", + "requisition_list_uid": "4" } ``` @@ -365,9 +365,9 @@ Contains the source and target wish lists after moving products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -389,23 +389,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](types-q-s.md#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. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#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. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -415,19 +415,19 @@ Contains details about a negotiable quote. "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "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": 123.45, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -441,15 +441,15 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | +| `code` - [`String!`](types-q-s.md#string) | The address country code. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | #### Example ```json { "code": "xyz789", - "label": "abc123" + "label": "xyz789" } ``` @@ -463,17 +463,17 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example @@ -482,11 +482,11 @@ Defines the billing or shipping address to be applied to the cart. "city": "abc123", "company": "abc123", "country_code": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123", - "postcode": "xyz789", - "region": "abc123", - "region_id": 123, + "postcode": "abc123", + "region": "xyz789", + "region_id": 987, "save_in_address_book": true, "street": ["abc123"], "telephone": "xyz789" @@ -501,15 +501,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -522,14 +522,14 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", + "firstname": "abc123", "lastname": "xyz789", - "postcode": "xyz789", + "postcode": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "abc123" } ``` @@ -544,17 +544,17 @@ Defines the company's state or province. | 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. | +| `code` - [`String`](types-q-s.md#string) | The address region code. | +| `label` - [`String`](types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "xyz789", - "label": "xyz789", - "region_id": 987 + "code": "abc123", + "label": "abc123", + "region_id": 123 } ``` @@ -566,15 +566,15 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example @@ -585,10 +585,10 @@ Defines the company's state or province. "country": NegotiableQuoteAddressCountry, "firstname": "abc123", "lastname": "xyz789", - "postcode": "xyz789", + "postcode": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "abc123" + "street": ["abc123"], + "telephone": "xyz789" } ``` @@ -603,9 +603,9 @@ Defines the billing address. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example @@ -613,7 +613,7 @@ Defines the billing address. { "address": NegotiableQuoteAddressInput, "customer_address_uid": 4, - "same_as_shipping": false, + "same_as_shipping": true, "use_for_shipping": true } ``` @@ -629,17 +629,17 @@ Contains a single plain text comment from either the buyer or seller. | 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. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { "author": NegotiableQuoteUser, - "created_at": "xyz789", + "created_at": "abc123", "creator_type": "BUYER", "text": "xyz789", "uid": "4" @@ -673,7 +673,7 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | +| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | #### Example @@ -691,15 +691,15 @@ Contains custom log entries added by third-party extensions. | 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. | +| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { - "new_value": "xyz789", + "new_value": "abc123", "old_value": "xyz789", "title": "abc123" } @@ -715,8 +715,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -767,7 +767,7 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example @@ -788,8 +788,8 @@ Contains details about a change for a negotiable quote. | `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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -832,15 +832,15 @@ Contains a new expiration date and the previous date. | 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. | +| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { "new_expiration": "xyz789", - "old_expiration": "xyz789" + "old_expiration": "abc123" } ``` @@ -854,14 +854,14 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#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_catalog": ["4"], "products_removed_from_quote": [ProductInterface] } ``` @@ -935,7 +935,7 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example @@ -953,13 +953,13 @@ Specifies the updated quantity of an item. | 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. | +| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -{"quantity": 123.45, "quote_item_uid": 4} +{"quantity": 987.65, "quote_item_uid": 4} ``` @@ -972,8 +972,8 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -994,10 +994,10 @@ Contains a reference document link for a negotiable quote template. | 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. | +| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID!`](types-f-i.md#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | #### Example @@ -1005,8 +1005,8 @@ Contains a reference document link for a negotiable quote template. { "document_identifier": "xyz789", "document_name": "abc123", - "link_id": "4", - "reference_document_url": "xyz789" + "link_id": 4, + "reference_document_url": "abc123" } ``` @@ -1018,17 +1018,17 @@ Contains a reference document link for a negotiable quote template. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](types-q-s.md#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. | +| `selected_shipping_method` - [`SelectedShippingMethod`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | #### Example @@ -1036,15 +1036,15 @@ Contains a reference document link for a negotiable quote template. { "available_shipping_methods": [AvailableShippingMethod], "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", "lastname": "xyz789", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -1059,15 +1059,15 @@ Defines shipping addresses for the negotiable quote. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, + "customer_address_uid": "4", "customer_notes": "abc123" } ``` @@ -1082,7 +1082,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1145,21 +1145,21 @@ Contains details about a negotiable quote template. |------------|-------------| | `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. | +| `expiration_date` - [`String!`](types-q-s.md#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. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](types-c-e.md#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. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | #### Example @@ -1167,13 +1167,13 @@ Contains details about a negotiable quote template. { "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": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -1181,8 +1181,8 @@ Contains details about a negotiable quote template. NegotiableQuoteReferenceDocumentLink ], "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "abc123", - "template_id": "4", + "status": "xyz789", + "template_id": 4, "total_quantity": 123.45 } ``` @@ -1197,8 +1197,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1219,21 +1219,21 @@ Contains data for a negotiable quote template in a grid. | 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. | +| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -1241,19 +1241,19 @@ Contains data for a negotiable quote template in a grid. { "activated_at": "abc123", "company_name": "xyz789", - "expiration_date": "xyz789", - "is_min_max_qty_used": false, - "last_shared_at": "abc123", - "max_order_commitment": 123, + "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, + "min_order_commitment": 123, "name": "abc123", "orders_placed": 987, - "sales_rep_name": "abc123", - "state": "xyz789", - "status": "xyz789", - "submitted_by": "xyz789", - "template_id": 4 + "sales_rep_name": "xyz789", + "state": "abc123", + "status": "abc123", + "submitted_by": "abc123", + "template_id": "4" } ``` @@ -1267,10 +1267,10 @@ Specifies the updated quantity of an 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. | +| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | #### Example @@ -1278,8 +1278,8 @@ Specifies the updated quantity of an item. { "item_id": "4", "max_qty": 123.45, - "min_qty": 987.65, - "quantity": 123.45 + "min_qty": 123.45, + "quantity": 987.65 } ``` @@ -1293,18 +1293,18 @@ Defines the reference document link to add to a negotiable quote template. | 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. | +| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | #### Example ```json { "document_identifier": "abc123", - "document_name": "abc123", - "link_id": 4, + "document_name": "xyz789", + "link_id": "4", "reference_document_url": "xyz789" } ``` @@ -1320,16 +1320,16 @@ Defines shipping addresses for the negotiable quote template. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "xyz789" + "customer_address_uid": "4", + "customer_notes": "abc123" } ``` @@ -1343,7 +1343,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1380,9 +1380,9 @@ Contains a list of negotiable templates that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1391,7 +1391,7 @@ Contains a list of negotiable templates that match the specified filter. "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } ``` @@ -1403,7 +1403,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1414,7 +1414,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -1427,7 +1427,7 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1445,8 +1445,8 @@ A limited view of a Buyer or Seller in the negotiable quote process. | 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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | #### Example @@ -1468,9 +1468,9 @@ Contains a list of negotiable that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1493,14 +1493,14 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json { - "message": "xyz789", + "message": "abc123", "uid": "4" } ``` @@ -1515,12 +1515,12 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -1533,15 +1533,15 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json { - "order_id": "abc123", - "order_number": "xyz789" + "order_id": "xyz789", + "order_number": "abc123" } ``` @@ -1575,41 +1575,41 @@ Contains detailed information about an order's billing and shipping addresses. | 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). | +| `city` - [`String!`](types-q-s.md#string) | The city or town. | +| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "fax": "abc123", - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", + "firstname": "abc123", + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "xyz789", "prefix": "abc123", - "region": "abc123", + "region": "xyz789", "region_id": "4", - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "abc123", "vat_id": "abc123" } @@ -1623,20 +1623,20 @@ Contains detailed information about an order's billing and shipping addresses. | 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 | +| `firstname` - [`String!`](types-q-s.md#string) | First name of the customer | +| `lastname` - [`String`](types-q-s.md#string) | Last name of the customer | +| `middlename` - [`String`](types-q-s.md#string) | Middle name of the customer | +| `prefix` - [`String`](types-q-s.md#string) | Prefix of the customer | +| `suffix` - [`String`](types-q-s.md#string) | Suffix of the customer | #### Example ```json { - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123", "middlename": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "suffix": "abc123" } ``` @@ -1649,28 +1649,28 @@ Contains detailed information about an order's billing and shipping addresses. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -1681,20 +1681,20 @@ Contains detailed information about an order's billing and shipping addresses. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "product_type": "abc123", "product_url_key": "abc123", "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, - "quantity_returned": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 123.45, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" @@ -1711,37 +1711,37 @@ Order item details. | 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. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`ConfigurableOrderItem`](#configurableorderitem) | -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`ConfigurableOrderItem`](types-c-e.md#configurableorderitem) | +| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | +| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | +| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1756,14 +1756,14 @@ Order item details. "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", + "product_sku": "xyz789", + "product_type": "xyz789", "product_url_key": "xyz789", - "quantity_canceled": 123.45, + "quantity_canceled": 987.65, "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, "quantity_return_requested": 123.45, "quantity_returned": 987.65, @@ -1783,14 +1783,14 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | +| `label` - [`String!`](types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -1803,8 +1803,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](types-f-i.md#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. | @@ -1844,8 +1844,8 @@ Contains details about the payment method used to pay for the order. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example @@ -1853,7 +1853,7 @@ Contains details about the payment method used to pay for the order. { "additional_data": [KeyValue], "name": "abc123", - "type": "xyz789" + "type": "abc123" } ``` @@ -1867,18 +1867,18 @@ Contains order shipment details. | 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. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example ```json { "comments": [SalesCommentItem], - "id": "4", + "id": 4, "items": [ShipmentItemInterface], "number": "abc123", "tracking": [ShipmentTracking] @@ -1895,7 +1895,7 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](#string) | Order token. | +| `token` - [`String!`](types-q-s.md#string) | Order token. | #### Example @@ -1914,15 +1914,15 @@ Contains details about the sales total amounts used to calculate the final price | 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) | | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#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. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#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. | @@ -1961,14 +1961,14 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { - "payer_id": "xyz789", + "payer_id": "abc123", "token": "xyz789" } ``` @@ -1983,17 +1983,17 @@ A set of relative URLs that PayPal uses in response to various actions during th | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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", + "cancel_url": "abc123", "error_url": "abc123", - "return_url": "xyz789" + "return_url": "abc123" } ``` @@ -2027,9 +2027,9 @@ Contains information used to generate PayPal iframe for transaction. Applies to | 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. | +| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example @@ -2038,7 +2038,7 @@ Contains information used to generate PayPal iframe for transaction. Applies to "mode": "TEST", "paypal_url": "xyz789", "secure_token": "abc123", - "secure_token_id": "abc123" + "secure_token_id": "xyz789" } ``` @@ -2052,12 +2052,12 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -2070,8 +2070,8 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | 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. | +| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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 @@ -2092,14 +2092,14 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "paypal_payload": "xyz789" } ``` @@ -2112,7 +2112,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -2130,7 +2130,7 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | | `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example @@ -2152,17 +2152,17 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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", + "cancel_url": "xyz789", "error_url": "abc123", - "return_url": "abc123" + "return_url": "xyz789" } ``` @@ -2176,33 +2176,33 @@ Contains payment fields that are common to all types of payment methods. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | -| [`ApplePayConfig`](#applepayconfig) | -| [`GooglePayConfig`](#googlepayconfig) | -| [`FastlaneConfig`](#fastlaneconfig) | +| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | +| [`ApplePayConfig`](types-a-b.md#applepayconfig) | +| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | +| [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | #### Example ```json { - "code": "xyz789", - "is_visible": true, - "payment_intent": "abc123", + "code": "abc123", + "is_visible": false, + "payment_intent": "xyz789", "sdk_params": [SDKParams], "sort_order": "abc123", - "title": "abc123" + "title": "xyz789" } ``` @@ -2216,11 +2216,11 @@ Retrieves the payment configuration for a given location | 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 | +| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `fastlane` - [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | Fastlane payment method configuration | +| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2267,28 +2267,28 @@ Defines the payment method. | 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. | +| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](types-f-i.md#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 | +| `payflowpro_cc_vault` - [`VaultTokenInput`](types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](types-f-i.md#fastlanemethodinput) | Required input for fastlane | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#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. | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -2302,7 +2302,7 @@ Defines the payment method. "braintree_googlepay_vault": BraintreeVaultInput, "braintree_paypal": BraintreeInput, "braintree_paypal_vault": BraintreeVaultInput, - "code": "xyz789", + "code": "abc123", "hosted_pro": HostedProInput, "payflow_express": PayflowExpressInput, "payflow_link": PayflowLinkInput, @@ -2315,7 +2315,7 @@ Defines the payment method. "payment_services_paypal_smart_buttons": SmartButtonMethodInput, "payment_services_paypal_vault": VaultMethodInput, "paypal_express": PaypalExpressInput, - "purchase_order_number": "abc123" + "purchase_order_number": "xyz789" } ``` @@ -2329,19 +2329,19 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#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 | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example ```json { "id": "xyz789", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } ``` @@ -2353,14 +2353,14 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | +| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | #### Example ```json { - "code": "xyz789", + "code": "abc123", "params": [SDKParams] } ``` @@ -2373,7 +2373,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | +| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2391,7 +2391,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | +| `card` - [`CardPaymentSourceInput!`](types-c-e.md#cardpaymentsourceinput) | The card payment source information | #### Example @@ -2409,7 +2409,7 @@ The payment source information | Field Name | Description | |------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | +| `card` - [`CardPaymentSourceOutput!`](types-c-e.md#cardpaymentsourceoutput) | The card payment source information | #### Example @@ -2427,18 +2427,18 @@ The stored payment method available to the customer. | 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. | +| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "details": "abc123", + "details": "xyz789", "payment_method_code": "abc123", - "public_hash": "abc123", + "public_hash": "xyz789", "type": "card" } ``` @@ -2472,15 +2472,15 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { - "payer_id": "abc123", - "token": "abc123" + "payer_id": "xyz789", + "token": "xyz789" } ``` @@ -2494,18 +2494,18 @@ Defines the attributes required to receive a payment token for Express Checkout | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](types-a-b.md#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. | +| `use_paypal_credit` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { - "cart_id": "abc123", - "code": "xyz789", + "cart_id": "xyz789", + "code": "abc123", "express_button": true, "urls": PaypalExpressUrlsInput, "use_paypal_credit": true @@ -2523,7 +2523,7 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | 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. | +| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | #### Example @@ -2544,8 +2544,8 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | 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. | +| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | #### Example @@ -2566,10 +2566,10 @@ Contains a set of relative URLs that PayPal uses in response to various actions | 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. | +| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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 @@ -2578,7 +2578,7 @@ Contains a set of relative URLs that PayPal uses in response to various actions "cancel_url": "xyz789", "pending_url": "abc123", "return_url": "xyz789", - "success_url": "xyz789" + "success_url": "abc123" } ``` @@ -2592,17 +2592,17 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](types-f-i.md#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) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | #### Example @@ -2620,41 +2620,41 @@ Defines Pickup Location information. | 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) | | +| `city` - [`String`](types-q-s.md#string) | | +| `contact_name` - [`String`](types-q-s.md#string) | | +| `country_id` - [`String`](types-q-s.md#string) | | +| `description` - [`String`](types-q-s.md#string) | | +| `email` - [`String`](types-q-s.md#string) | | +| `fax` - [`String`](types-q-s.md#string) | | +| `latitude` - [`Float`](types-f-i.md#float) | | +| `longitude` - [`Float`](types-f-i.md#float) | | +| `name` - [`String`](types-q-s.md#string) | | +| `phone` - [`String`](types-q-s.md#string) | | +| `pickup_location_code` - [`String`](types-q-s.md#string) | | +| `postcode` - [`String`](types-q-s.md#string) | | +| `region` - [`String`](types-q-s.md#string) | | +| `region_id` - [`Int`](types-f-i.md#int) | | +| `street` - [`String`](types-q-s.md#string) | | #### Example ```json { "city": "xyz789", - "contact_name": "abc123", + "contact_name": "xyz789", "country_id": "xyz789", - "description": "abc123", + "description": "xyz789", "email": "abc123", "fax": "xyz789", "latitude": 123.45, "longitude": 987.65, - "name": "xyz789", - "phone": "xyz789", + "name": "abc123", + "phone": "abc123", "pickup_location_code": "xyz789", "postcode": "xyz789", "region": "xyz789", - "region_id": 987, - "street": "xyz789" + "region_id": 123, + "street": "abc123" } ``` @@ -2668,14 +2668,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | 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. | +| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2702,22 +2702,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | 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. | +| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2753,8 +2753,8 @@ Top level object returned in a pickup locations search. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | #### Example @@ -2762,7 +2762,7 @@ Top level object returned in a pickup locations search. { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2776,12 +2776,12 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -2813,14 +2813,14 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "CART_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -2854,12 +2854,12 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json -{"purchase_order_uid": 4} +{"purchase_order_uid": "4"} ``` @@ -2872,7 +2872,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | #### Example @@ -2890,12 +2890,12 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -2910,7 +2910,7 @@ Contains the results of the request to place an order. |------------|-------------| | `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. | +| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | #### Example @@ -2932,7 +2932,7 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -3053,15 +3053,15 @@ Can be used to retrieve the main price details in case of bundle product | 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 | +| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | #### Example ```json { - "discount_percentage": 123.45, + "discount_percentage": 987.65, "main_final_price": 987.65, "main_price": 123.45 } @@ -3138,15 +3138,15 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | +| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | #### Example ```json { - "code": "xyz789", - "value": "abc123" + "code": "abc123", + "value": "xyz789" } ``` @@ -3160,15 +3160,15 @@ Defines the filters to be used in the search. A filter contains at least one att | 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 | +| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | +| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -3196,10 +3196,10 @@ Specifies the attribute to use for sorting search results and indicates whether | 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). | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -3217,8 +3217,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3239,13 +3239,13 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | #### Example ```json -{"amount_off": 987.65, "percent_off": 123.45} +{"amount_off": 123.45, "percent_off": 123.45} ``` @@ -3258,45 +3258,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | 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. | +| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](types-f-i.md#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. | +| `price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -3354,11 +3354,11 @@ Contains product image information, including the image URL and label. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Example @@ -3368,7 +3368,7 @@ Contains product image information, including the image URL and label. "label": "abc123", "position": 987, "types": ["xyz789"], - "url": "xyz789" + "url": "abc123" } ``` @@ -3399,12 +3399,12 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | +| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | #### Example ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` @@ -3417,94 +3417,94 @@ Contains fields that are common to all types of products. | 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.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#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. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#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`](types-f-i.md#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 | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](types-q-s.md#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. | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#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. | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#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. | +| `review_count` - [`Int!`](types-f-i.md#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. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#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. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#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. | +| `swatch_image` - [`String`](types-q-s.md#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_price` - [`Float`](types-f-i.md#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.)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#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.)* | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](types-t-z.md#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) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | #### Example ```json { "attribute_set_id": 987, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "abc123", + "color": 123, + "country_of_manufacture": "xyz789", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, + "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 123, + "id": 987, "image": ProductImage, "is_returnable": "abc123", "manufacturer": 987, @@ -3512,14 +3512,14 @@ Contains fields that are common to all types of products. "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options_container": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -3532,23 +3532,23 @@ Contains fields that are common to all types of products. "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "xyz789", + "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_id": "abc123", + "type_id": "xyz789", "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -3563,21 +3563,21 @@ An implementation of `ProductLinksInterface`. | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { - "link_type": "xyz789", - "linked_product_sku": "xyz789", - "linked_product_type": "abc123", - "position": 987, - "sku": "xyz789" + "link_type": "abc123", + "linked_product_sku": "abc123", + "linked_product_type": "xyz789", + "position": 123, + "sku": "abc123" } ``` @@ -3591,11 +3591,11 @@ Contains information about linked products, including the link type and product | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3610,8 +3610,8 @@ Contains information about linked products, including the link type and product "link_type": "abc123", "linked_product_sku": "xyz789", "linked_product_type": "xyz789", - "position": 987, - "sku": "xyz789" + "position": 123, + "sku": "abc123" } ``` @@ -3625,15 +3625,15 @@ Contains an image in base64 format and basic information about the image. | 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. | +| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "base64_encoded_data": "xyz789", + "base64_encoded_data": "abc123", "name": "xyz789", "type": "xyz789" } @@ -3649,12 +3649,12 @@ Contains a link to a video file and basic information about the video. | 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. | +| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | #### Example @@ -3681,7 +3681,7 @@ Represents a product price. |------------|-------------| | `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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#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 @@ -3729,13 +3729,13 @@ Contains details of a product review. | 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. | +| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](types-q-s.md#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. | +| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](types-q-s.md#string) | The review text. | #### Example @@ -3746,8 +3746,8 @@ Contains details of a product review. "nickname": "xyz789", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], - "summary": "abc123", - "text": "xyz789" + "summary": "xyz789", + "text": "abc123" } ``` @@ -3761,15 +3761,15 @@ Contains data about a single aspect of a product review. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example ```json { - "name": "abc123", - "value": "xyz789" + "name": "xyz789", + "value": "abc123" } ``` @@ -3783,15 +3783,15 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { "id": "abc123", - "value_id": "xyz789" + "value_id": "abc123" } ``` @@ -3805,8 +3805,8 @@ Contains details about a single aspect of a product review. | 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. | +| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](types-q-s.md#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 @@ -3829,8 +3829,8 @@ Contains details about a single value in a product review. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | #### Example @@ -3870,7 +3870,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -3910,21 +3910,21 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | 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.)* | +| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json { - "customer_group_id": "xyz789", + "customer_group_id": "abc123", "percentage_value": 123.45, - "qty": 987.65, + "qty": 123.45, "value": 123.45, - "website_id": 987.65 + "website_id": 123.45 } ``` @@ -3938,21 +3938,21 @@ Contains information about a product video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json { - "disabled": false, - "label": "abc123", - "position": 123, - "types": ["abc123"], + "disabled": true, + "label": "xyz789", + "position": 987, + "types": ["xyz789"], "url": "abc123", "video_content": ProductMediaGalleryEntriesVideoContent } @@ -3968,13 +3968,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](types-a-b.md#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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](types-f-i.md#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 @@ -4003,15 +4003,15 @@ Contains details about a purchase order. | `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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](types-c-e.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -4020,10 +4020,10 @@ Contains details about a purchase order. "approval_flow": [PurchaseOrderRuleApprovalFlow], "available_actions": ["REJECT"], "comments": [PurchaseOrderComment], - "created_at": "xyz789", + "created_at": "abc123", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], - "number": "xyz789", + "number": "abc123", "order": CustomerOrder, "quote": Cart, "status": "PENDING", @@ -4062,13 +4062,13 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{"message": "xyz789", "type": "NOT_FOUND"} ``` @@ -4081,19 +4081,19 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | +| `message` - [`String`](types-q-s.md#string) | A formatted message. | +| `name` - [`String`](types-q-s.md#string) | The approver name. | +| `role` - [`String`](types-q-s.md#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. | +| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { - "message": "xyz789", + "message": "abc123", "name": "abc123", - "role": "xyz789", + "role": "abc123", "status": "PENDING", "updated_at": "xyz789" } @@ -4127,16 +4127,16 @@ Contains details about a purchase order approval rule. | 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. | +| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -4146,9 +4146,9 @@ Contains details about a purchase order approval rule. "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", - "created_by": "abc123", - "description": "abc123", - "name": "abc123", + "created_by": "xyz789", + "description": "xyz789", + "name": "xyz789", "status": "ENABLED", "uid": "4", "updated_at": "xyz789" @@ -4236,12 +4236,12 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} ``` @@ -4254,11 +4254,11 @@ Defines a new purchase order approval rule. | 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. | +| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example @@ -4284,9 +4284,9 @@ Contains metadata that can be used to render rule edit forms. | 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. | +| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4344,8 +4344,8 @@ Contains the approval rules that the customer can see. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4353,7 +4353,7 @@ Contains the approval rules that the customer can see. { "items": [PurchaseOrderApprovalRule], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -4367,19 +4367,19 @@ Contains details about a comment. | 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. | +| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | #### Example ```json { "author": Customer, - "created_at": "xyz789", - "text": "xyz789", - "uid": "4" + "created_at": "abc123", + "text": "abc123", + "uid": 4 } ``` @@ -4413,19 +4413,19 @@ Contains details about a status change. | 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. | +| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { "activity": "abc123", - "created_at": "abc123", - "message": "abc123", - "uid": "4" + "created_at": "xyz789", + "message": "xyz789", + "uid": 4 } ``` @@ -4440,7 +4440,7 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | +| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | #### Example @@ -4486,8 +4486,8 @@ Contains a list of purchase orders. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4509,7 +4509,7 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | #### Example @@ -4549,18 +4549,18 @@ Defines the criteria to use to filter the list of purchase orders. | 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. | +| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](types-a-b.md#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, + "company_purchase_orders": false, "created_date": FilterRangeTypeInput, - "require_my_approval": true, + "require_my_approval": false, "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 index 9049e86ba..dac973f60 100644 --- 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 @@ -27,17 +27,17 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `item_id` - [`ID!`](types-f-i.md#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. | +| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "item_id": 4, - "note": "xyz789", - "templateId": 4 + "note": "abc123", + "templateId": "4" } ``` @@ -58,7 +58,7 @@ Contains a notification message for a negotiable quote template. ```json { - "message": "xyz789", + "message": "abc123", "type": "abc123" } ``` @@ -72,14 +72,14 @@ Contains a notification message for a negotiable quote template. | Field Name | Description | |------------|-------------| | `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | +| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | #### Example ```json { "configurations": ReCaptchaConfiguration, - "is_enabled": true + "is_enabled": false } ``` @@ -95,7 +95,7 @@ Contains reCAPTCHA form configuration details. |------------|-------------| | `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. | +| `minimum_score` - [`Float`](types-f-i.md#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. | @@ -106,14 +106,14 @@ Contains reCAPTCHA form configuration details. ```json { - "badge_position": "abc123", - "language_code": "xyz789", - "minimum_score": 987.65, + "badge_position": "xyz789", + "language_code": "abc123", + "minimum_score": 123.45, "re_captcha_type": "INVISIBLE", "technical_failure_message": "xyz789", - "theme": "xyz789", - "validation_failure_message": "abc123", - "website_key": "abc123" + "theme": "abc123", + "validation_failure_message": "xyz789", + "website_key": "xyz789" } ``` @@ -130,9 +130,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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 | +| `is_enabled` - [`Boolean!`](types-a-b.md#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. | +| `minimum_score` - [`Float!`](types-f-i.md#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. | @@ -141,7 +141,7 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { "badge_position": "abc123", - "failure_message": "xyz789", + "failure_message": "abc123", "forms": ["PLACE_ORDER"], "is_enabled": false, "language_code": "abc123", @@ -204,16 +204,16 @@ Contains reCAPTCHA V3-Invisible configuration details. | 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. | +| `id` - [`Int`](types-f-i.md#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" + "code": "xyz789", + "id": 123, + "name": "xyz789" } ``` @@ -245,7 +245,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -292,7 +292,7 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "gift_card_code": "xyz789" } ``` @@ -307,7 +307,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -325,7 +325,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -343,12 +343,12 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -361,7 +361,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -380,16 +380,16 @@ Specifies which items to remove from the cart. | 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. | +| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { "cart_id": "abc123", - "cart_item_id": 987, - "cart_item_uid": "4" + "cart_item_id": 123, + "cart_item_uid": 4 } ``` @@ -403,7 +403,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -421,16 +421,13 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "quote_item_uids": ["4"], - "quote_uid": "4" -} +{"quote_item_uids": [4], "quote_uid": "4"} ``` @@ -443,7 +440,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -461,8 +458,8 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -480,13 +477,13 @@ Defines which products to remove from a compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": [4], "uid": 4} +{"products": ["4"], "uid": 4} ``` @@ -499,8 +496,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -521,7 +518,7 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example @@ -557,7 +554,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -580,7 +577,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -593,7 +590,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -613,13 +610,13 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example ```json { - "quote_comment": "xyz789", + "quote_comment": "abc123", "quote_name": "xyz789", "quote_uid": "4" } @@ -635,7 +632,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -653,8 +650,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -684,7 +681,7 @@ Contains information needed to start a return request. ```json { - "comment_text": "abc123", + "comment_text": "xyz789", "contact_email": "abc123", "items": [RequestReturnItemInput], "token": "xyz789" @@ -701,19 +698,19 @@ Defines properties of a negotiable quote request. | 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. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](types-a-b.md#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, + "cart_id": "4", "comment": NegotiableQuoteCommentInput, "is_draft": false, - "quote_name": "abc123" + "quote_name": "xyz789" } ``` @@ -727,7 +724,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -745,12 +742,12 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example ```json -{"cart_id": "4"} +{"cart_id": 4} ``` @@ -766,16 +763,16 @@ Contains information needed to start a return request. | `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. | +| `order_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { "comment_text": "xyz789", - "contact_email": "abc123", + "contact_email": "xyz789", "items": [RequestReturnItemInput], - "order_uid": "4" + "order_uid": 4 } ``` @@ -789,9 +786,9 @@ Contains details about an item to be returned. | 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. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](types-f-i.md#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 @@ -802,7 +799,7 @@ Contains details about an item to be returned. EnteredCustomAttributeInput ], "order_item_uid": "4", - "quantity_to_return": 123.45, + "quantity_to_return": 987.65, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -843,10 +840,10 @@ Defines the contents of a requisition list. |------------|-------------| | `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. | +| `items_count` - [`Int!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example @@ -855,10 +852,10 @@ Defines the contents of a requisition list. { "description": "xyz789", "items": RequistionListItems, - "items_count": 123, - "name": "xyz789", + "items_count": 987, + "name": "abc123", "requisition_list_items": RequisitionListItems, - "uid": "4", + "uid": 4, "updated_at": "abc123" } ``` @@ -873,8 +870,8 @@ Defines requisition list filters. | 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. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -896,20 +893,20 @@ The interface for requisition list items. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#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) | +| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -934,7 +931,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `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. | +| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | #### Example @@ -942,7 +939,7 @@ Contains an array of items added to a requisition list. { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 123 + "total_pages": 987 } ``` @@ -956,9 +953,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#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. | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -967,9 +964,9 @@ Defines the items to add. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["xyz789"], + "parent_sku": "abc123", + "quantity": 987.65, + "selected_options": ["abc123"], "sku": "abc123" } ``` @@ -986,7 +983,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -994,7 +991,7 @@ Defines customer requisition lists. { "items": [RequisitionList], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1010,7 +1007,7 @@ Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed |------------|-------------| | `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. | +| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | #### Example @@ -1038,10 +1035,10 @@ Contains details about a return. | `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. | +| `order` - [`CustomerOrder`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -1049,14 +1046,14 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "abc123", + "created_at": "xyz789", "customer": ReturnCustomer, "items": [ReturnItem], "number": "xyz789", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -1073,7 +1070,7 @@ Contains details about a return comment. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example @@ -1081,8 +1078,8 @@ Contains details about a return comment. { "author_name": "xyz789", "created_at": "abc123", - "text": "xyz789", - "uid": "4" + "text": "abc123", + "uid": 4 } ``` @@ -1097,14 +1094,14 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "uid": 4, "value": "xyz789" } @@ -1128,7 +1125,7 @@ The customer information for the return. ```json { - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "lastname": "abc123" } @@ -1145,12 +1142,12 @@ Contains details about a product being returned. | 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. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1162,7 +1159,7 @@ Contains details about a product being returned. "quantity": 123.45, "request_quantity": 987.65, "status": "PENDING", - "uid": 4 + "uid": "4" } ``` @@ -1176,36 +1173,36 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](types-f-i.md#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. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#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. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#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. | +| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { - "code": 4, + "code": "4", "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, - "is_unique": true, + "is_required": false, + "is_unique": false, "label": "abc123", - "multiline_count": 987, + "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 987, + "sort_order": 123, "validate_rules": [ValidationRule] } ``` @@ -1265,7 +1262,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `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. | +| `country` - [`Country!`](types-c-e.md#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. | @@ -1276,12 +1273,12 @@ Contains details about the shipping address used for receiving returned items. ```json { "city": "xyz789", - "contact_name": "xyz789", + "contact_name": "abc123", "country": Country, - "postcode": "abc123", + "postcode": "xyz789", "region": Region, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -1296,12 +1293,15 @@ Contains details about the carrier on a return. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example ```json -{"label": "xyz789", "uid": 4} +{ + "label": "xyz789", + "uid": "4" +} ``` @@ -1317,7 +1317,7 @@ Contains shipping and tracking details. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1326,7 +1326,7 @@ Contains shipping and tracking details. "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, "tracking_number": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1346,7 +1346,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "xyz789", "type": "INFORMATION"} +{"text": "abc123", "type": "INFORMATION"} ``` @@ -1406,7 +1406,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | #### Example @@ -1428,12 +1428,12 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example ```json -{"result": false} +{"result": true} ``` @@ -1470,8 +1470,8 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | #### Example @@ -1492,7 +1492,7 @@ Contain details about the reward points transaction. | `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. | +| `points_change` - [`Float!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example @@ -1501,7 +1501,7 @@ Contain details about the reward points transaction. "balance": RewardPointsAmount, "change_reason": "xyz789", "date": "abc123", - "points_change": 123.45 + "points_change": 987.65 } ``` @@ -1537,13 +1537,13 @@ Contains details about customer's reward points rate. | 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. | +| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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} +{"currency_amount": 123.45, "points": 987.65} ``` @@ -1595,30 +1595,30 @@ Routable entities serve as the model for a rendered page. | 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. | +| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | +| [`CmsPage`](types-c-e.md#cmspage) | +| [`CategoryTree`](types-c-e.md#categorytree) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | | [`RoutableUrl`](#routableurl) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | #### Example ```json { - "redirect_code": 123, + "redirect_code": 987, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -1634,16 +1634,16 @@ Default implementation of RoutableInterface. This type is returned when the URL | 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. | +| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "redirect_code": 987, - "relative_url": "abc123", + "redirect_code": 123, + "relative_url": "xyz789", "type": "CMS_PAGE" } ``` @@ -1666,7 +1666,7 @@ Defines the name and value of a SDK parameter ```json { "name": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -1722,14 +1722,14 @@ Provides navigation for the query response. | 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. | +| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 123, "page_size": 123, "total_pages": 987} +{"current_page": 123, "page_size": 987, "total_pages": 987} ``` @@ -1747,7 +1747,7 @@ A string that contains search suggestion #### Example ```json -{"search": "xyz789"} +{"search": "abc123"} ``` @@ -1760,20 +1760,20 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](types-f-i.md#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 | +| `uid` - [`ID!`](types-f-i.md#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, + "id": 123, + "label": "abc123", + "type": "xyz789", + "uid": "4", "values": [SelectedBundleOptionValue] } ``` @@ -1788,25 +1788,25 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | +| `id` - [`Int!`](types-f-i.md#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 | +| `original_price` - [`Money!`](types-k-p.md#money) | The original price of the value for the selected bundle product option. | +| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | +| `priceV2` - [`Money!`](types-k-p.md#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { "id": 987, - "label": "abc123", + "label": "xyz789", "original_price": Money, "price": 123.45, "priceV2": Money, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -1820,23 +1820,23 @@ Contains details about a selected configurable option. | 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.)* | +| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](types-f-i.md#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_id` - [`Int!`](types-f-i.md#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, + "configurable_product_option_uid": 4, + "configurable_product_option_value_uid": 4, + "id": 123, "option_label": "xyz789", - "value_id": 123, - "value_label": "xyz789" + "value_id": 987, + "value_label": "abc123" } ``` @@ -1857,8 +1857,8 @@ Contains details about an attribute the buyer selected. ```json { - "attribute_code": "xyz789", - "value": "abc123" + "attribute_code": "abc123", + "value": "xyz789" } ``` @@ -1872,11 +1872,11 @@ Identifies a customized product that has been placed in a cart. | 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. | +| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](types-a-b.md#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. | +| `sort_order` - [`Int!`](types-f-i.md#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. | @@ -1886,10 +1886,10 @@ Identifies a customized product that has been placed in a cart. { "customizable_option_uid": 4, "id": 123, - "is_required": true, + "is_required": false, "label": "abc123", - "sort_order": 123, - "type": "abc123", + "sort_order": 987, + "type": "xyz789", "values": [SelectedCustomizableOptionValue] } ``` @@ -1904,10 +1904,10 @@ Identifies the value of the selected customized option. | 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.)* | +| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](types-f-i.md#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. | +| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | | `value` - [`String!`](#string) | The text identifying the selected value. | #### Example @@ -1915,10 +1915,10 @@ Identifies the value of the selected customized option. ```json { "customizable_option_value_uid": "4", - "id": 123, - "label": "xyz789", + "id": 987, + "label": "abc123", "price": CartItemSelectedOptionValuePrice, - "value": "xyz789" + "value": "abc123" } ``` @@ -1940,9 +1940,9 @@ Describes the payment method the shopper selected. ```json { - "code": "abc123", + "code": "xyz789", "purchase_order_number": "xyz789", - "title": "xyz789" + "title": "abc123" } ``` @@ -1956,14 +1956,14 @@ Contains details about the selected shipping method and carrier. | 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.)* | +| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](types-k-p.md#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. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1972,8 +1972,8 @@ Contains details about the selected shipping method and carrier. "amount": Money, "base_amount": Money, "carrier_code": "abc123", - "carrier_title": "abc123", - "method_code": "abc123", + "carrier_title": "xyz789", + "method_code": "xyz789", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -1990,7 +1990,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](types-f-i.md#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. | @@ -1998,7 +1998,7 @@ Defines the referenced product and the email sender and recipients. ```json { - "product_id": 123, + "product_id": 987, "recipients": [SendEmailToFriendRecipientInput], "sender": SendEmailToFriendSenderInput } @@ -2044,7 +2044,7 @@ An output object that contains information about the recipient. ```json { "email": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -2065,7 +2065,7 @@ Contains details about a recipient. ```json { - "email": "xyz789", + "email": "abc123", "name": "xyz789" } ``` @@ -2088,7 +2088,7 @@ An output object that contains information about the sender. ```json { - "email": "abc123", + "email": "xyz789", "message": "xyz789", "name": "xyz789" } @@ -2128,13 +2128,13 @@ Contains details about the configuration of the Email to a Friend feature. | 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. | +| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": false, "enabled_for_guests": false} +{"enabled_for_customers": true, "enabled_for_guests": true} ``` @@ -2147,8 +2147,8 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2169,7 +2169,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2187,7 +2187,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2195,7 +2195,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "xyz789" + "cart_id": "abc123" } ``` @@ -2209,7 +2209,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2228,12 +2228,12 @@ Sets the cart as inactive | 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 | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart was set as inactive | #### Example ```json -{"error": "xyz789", "success": true} +{"error": "abc123", "success": false} ``` @@ -2247,10 +2247,10 @@ Defines the gift options applied to the cart. | 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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example @@ -2259,8 +2259,8 @@ Defines the gift options applied to the cart. "cart_id": "xyz789", "gift_message": GiftMessageInput, "gift_receipt_included": true, - "gift_wrapping_id": 4, - "printed_card_included": true + "gift_wrapping_id": "4", + "printed_card_included": false } ``` @@ -2274,7 +2274,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | #### Example @@ -2314,7 +2314,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2332,7 +2332,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2350,8 +2350,8 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2372,7 +2372,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2390,15 +2390,15 @@ Defines the payment method of the specified negotiable quote. | 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. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2412,7 +2412,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2430,16 +2430,16 @@ Defines the shipping address to assign to the negotiable quote. | 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. | +| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { "customer_address_id": "4", - "quote_uid": 4, + "quote_uid": "4", "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2456,7 +2456,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2474,14 +2474,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#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", + "quote_uid": 4, "shipping_methods": [ShippingMethodInput] } ``` @@ -2496,7 +2496,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2514,8 +2514,8 @@ Defines the shipping address to assign to the negotiable quote template. | 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. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2537,7 +2537,7 @@ Applies a payment method to the quote. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2559,7 +2559,7 @@ Applies a payment method to the cart. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2580,7 +2580,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2620,7 +2620,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2645,7 +2645,7 @@ Applies one or shipping methods to the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "shipping_methods": [ShippingMethodInput] } ``` @@ -2660,7 +2660,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2685,7 +2685,7 @@ Defines a gift registry invitee. ```json { - "email": "xyz789", + "email": "abc123", "name": "abc123" } ``` @@ -2700,7 +2700,7 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example @@ -2726,7 +2726,7 @@ Defines the sender of an invitation to view a gift registry. ```json { "message": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -2757,20 +2757,20 @@ Defines whether bundle items must be shipped together. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example ```json { - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "quantity_shipped": 123.45 @@ -2787,31 +2787,31 @@ Order shipment item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example ```json { - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -2833,9 +2833,9 @@ Contains order shipment tracking details. ```json { - "carrier": "abc123", - "number": "abc123", - "title": "xyz789" + "carrier": "xyz789", + "number": "xyz789", + "title": "abc123" } ``` @@ -2849,9 +2849,9 @@ Defines a single shipping address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_address_uid` - [`ID`](types-f-i.md#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. | @@ -2860,10 +2860,10 @@ Defines a single shipping address. ```json { "address": CartAddressInput, - "customer_address_id": 987, - "customer_address_uid": "4", - "customer_notes": "xyz789", - "pickup_location_code": "abc123" + "customer_address_id": 123, + "customer_address_uid": 4, + "customer_notes": "abc123", + "pickup_location_code": "xyz789" } ``` @@ -2877,31 +2877,31 @@ Contains shipping addresses and methods. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#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. | +| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](types-f-i.md#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.)* | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `items_weight` - [`Float`](types-f-i.md#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. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](types-a-b.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | | `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example @@ -2911,16 +2911,16 @@ Contains shipping addresses and methods. "available_shipping_methods": [AvailableShippingMethod], "cart_items": [CartItemQuantity], "cart_items_v2": [CartItemInterface], - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", "customer_notes": "xyz789", - "fax": "abc123", - "firstname": "abc123", - "id": 123, - "items_weight": 123.45, + "fax": "xyz789", + "firstname": "xyz789", + "id": 987, + "items_weight": 987.65, "lastname": "xyz789", "middlename": "abc123", "pickup_location_code": "abc123", @@ -2929,10 +2929,10 @@ Contains shipping addresses and methods. "region": CartAddressRegion, "same_as_billing": false, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", - "uid": "4", + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "uid": 4, "vat_id": "xyz789" } ``` @@ -2947,7 +2947,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | #### Example @@ -2965,11 +2965,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](types-k-p.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | #### Example @@ -3000,8 +3000,8 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "abc123", - "method_code": "abc123" + "carrier_code": "xyz789", + "method_code": "xyz789" } ``` @@ -3015,23 +3015,23 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#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. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#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 | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#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. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -3044,15 +3044,15 @@ An implementation for simple product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "abc123", - "is_available": true, - "max_qty": 123.45, - "min_qty": 123.45, + "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, + "quantity": 987.65, "uid": "4" } ``` @@ -3067,99 +3067,99 @@ Defines a simple product, which is tangible and is usually sold in single units | 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.)* | +| `attribute_set_id` - [`Int`](types-f-i.md#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.)* | +| `categories` - [`[CategoryInterface]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#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. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#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.)* | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#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 | +| `min_sale_qty` - [`Float`](types-f-i.md#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. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#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. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#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. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#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. | +| `small_image` - [`ProductImage`](types-k-p.md#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_price` - [`Float`](types-f-i.md#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 | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#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. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#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. | +| `uid` - [`ID!`](types-f-i.md#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. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#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_rewrites` - [`[UrlRewrite]`](types-t-z.md#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. | +| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { "attribute_set_id": 123, - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 987, + "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "min_sale_qty": 987.65, "name": "xyz789", - "new_from_date": "abc123", + "new_from_date": "xyz789", "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], @@ -3169,28 +3169,28 @@ Defines a simple product, which is tangible and is usually sold in single units "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, - "rating_summary": 987.65, - "redirect_code": 123, + "rating_summary": 123.45, + "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", + "relative_url": "abc123", "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": false, "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", - "uid": 4, - "updated_at": "abc123", + "type_id": "xyz789", + "uid": "4", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "xyz789", @@ -3211,8 +3211,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -3234,9 +3234,9 @@ Contains details about simple products added to a requisition list. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3244,8 +3244,8 @@ Contains details about simple products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -3262,20 +3262,20 @@ Contains a simple 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. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -3298,8 +3298,8 @@ Smart button payment inputs ```json { "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "payments_order_id": "abc123", + "paypal_order_id": "abc123" } ``` @@ -3311,13 +3311,13 @@ Smart button payment inputs | 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 | +| `app_switch_when_available` - [`Boolean`](types-a-b.md#boolean) | Indicated whether to use App Switch on enabled mobile devices | +| `button_styles` - [`ButtonStyles`](types-a-b.md#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 | +| `display_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](types-k-p.md#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 | @@ -3327,17 +3327,17 @@ Smart button payment inputs ```json { - "app_switch_when_available": false, + "app_switch_when_available": true, "button_styles": ButtonStyles, "code": "xyz789", - "display_message": false, - "display_venmo": false, - "is_visible": false, + "display_message": true, + "display_venmo": true, + "is_visible": true, "message_styles": MessageStyles, "payment_intent": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "abc123" + "sort_order": "abc123", + "title": "xyz789" } ``` @@ -3377,8 +3377,8 @@ Defines a possible sort field. ```json { - "label": "xyz789", - "value": "abc123" + "label": "abc123", + "value": "xyz789" } ``` @@ -3399,7 +3399,7 @@ Contains a default value for sort fields and all available sort fields. ```json { - "default": "abc123", + "default": "xyz789", "options": [SortField] } ``` @@ -3472,27 +3472,27 @@ Contains information about a store's configuration. | `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. | +| `autocomplete_on_storefront` - [`Boolean`](types-a-b.md#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_allowspecific` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](types-a-b.md#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_3dsecure_verify_3dsecure` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](types-a-b.md#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_applepay_vault_active` - [`Boolean`](types-a-b.md#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_cc_vault_cvv` - [`Boolean`](types-a-b.md#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_googlepay_vault_active` - [`Boolean`](types-a-b.md#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. | @@ -3500,130 +3500,130 @@ Contains information about a store's configuration. | `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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_cart_type_paypal_show` - [`Boolean`](types-a-b.md#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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_checkout_type_paypal_show` - [`Boolean`](types-a-b.md#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_credit_show` - [`Boolean`](types-a-b.md#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_show` - [`Boolean`](types-a-b.md#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_paylater_show` - [`Boolean`](types-a-b.md#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_button_location_productpage_type_paypal_show` - [`Boolean`](types-a-b.md#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_display_on_shopping_cart` - [`Boolean`](types-a-b.md#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. | +| `braintree_paypal_require_billing_address` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](types-f-i.md#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. | +| `cart_summary_display_quantity` - [`Int`](types-f-i.md#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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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_product_image` - [`ProductImageThumbnail!`](types-k-p.md#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. | +| `contact_enabled` - [`Boolean!`](types-a-b.md#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. | +| `create_account_confirmation` - [`Boolean`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](types-f-i.md#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 | +| `demonotice` - [`Int`](types-f-i.md#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!`](types-f-i.md#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](types-f-i.md#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](types-a-b.md#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 | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](types-a-b.md#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. | +| `graphql_share_customer_group` - [`Boolean`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](types-f-i.md#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. | +| `grouped_product_image` - [`ProductImageThumbnail!`](types-k-p.md#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 | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_checkout_agreements_enabled` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#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` - [`Int`](types-f-i.md#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. | +| `logo_height` - [`Int`](types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](types-f-i.md#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. | @@ -3638,34 +3638,34 @@ Contains information about a store's configuration. | `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. | +| `max_items_in_order_summary` - [`Int`](types-f-i.md#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. | +| `minicart_display` - [`Boolean`](types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](types-f-i.md#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. | +| `newsletter_enabled` - [`Boolean!`](types-a-b.md#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 | +| `order_cancellation_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](types-a-b.md#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. | +| `printed_card_priceV2` - [`Money`](types-k-p.md#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `quickorder_active` - [`Boolean!`](types-a-b.md#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. | +| `root_category_id` - [`Int`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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`. | @@ -3673,215 +3673,215 @@ Contains information about a store's configuration. | `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. | +| `share_active_segments` - [`Boolean`](types-a-b.md#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | +| `share_applied_cart_rule` - [`Boolean`](types-a-b.md#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | +| `shopping_cart_display_full_summary` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#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. | +| `store_sort_order` - [`Int`](types-f-i.md#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.)* | +| `use_store_in_url` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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", + "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": "xyz789", - "allow_order": "abc123", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": true, + "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": "xyz789", + "base_link_url": "abc123", "base_media_url": "abc123", "base_static_url": "abc123", - "base_url": "abc123", + "base_url": "xyz789", "braintree_3dsecure_allowspecific": false, "braintree_3dsecure_always_request_3ds": true, "braintree_3dsecure_specificcountry": "xyz789", - "braintree_3dsecure_threshold_amount": "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_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_environment": "abc123", + "braintree_googlepay_btn_color": "abc123", + "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": "xyz789", + "braintree_local_payment_allowed_methods": "abc123", + "braintree_local_payment_fallback_button_text": "abc123", "braintree_local_payment_redirect_on_fail": "xyz789", "braintree_merchant_account_id": "xyz789", "braintree_paypal_button_location_cart_type_credit_color": "abc123", - "braintree_paypal_button_location_cart_type_credit_label": "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_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": "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_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": "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_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_checkout_type_credit_color": "abc123", + "braintree_paypal_button_location_checkout_type_credit_label": "xyz789", + "braintree_paypal_button_location_checkout_type_credit_shape": "abc123", "braintree_paypal_button_location_checkout_type_credit_show": false, "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_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_messaging_text_color": "xyz789", "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_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_paypal_color": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_label": "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": 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_checkout_type_paypal_show": true, + "braintree_paypal_button_location_productpage_type_credit_color": "abc123", + "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_shape": "abc123", + "braintree_paypal_button_location_productpage_type_credit_show": false, + "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123", + "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123", "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789", - "braintree_paypal_button_location_productpage_type_messaging_show": true, + "braintree_paypal_button_location_productpage_type_messaging_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_color": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_show": false, + "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_show": true, "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_button_location_productpage_type_paypal_show": false, "braintree_paypal_credit_uk_merchant_name": "abc123", - "braintree_paypal_display_on_shopping_cart": true, - "braintree_paypal_merchant_country": "abc123", + "braintree_paypal_display_on_shopping_cart": false, + "braintree_paypal_merchant_country": "xyz789", "braintree_paypal_merchant_name_override": "abc123", - "braintree_paypal_require_billing_address": true, - "braintree_paypal_send_cart_line_items": true, + "braintree_paypal_require_billing_address": false, + "braintree_paypal_send_cart_line_items": false, "braintree_paypal_vault_active": true, - "cart_expires_in_days": 987, + "cart_expires_in_days": 123, "cart_gift_wrapping": "xyz789", "cart_merge_preference": "abc123", "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 123, + "cart_summary_display_quantity": 987, "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", + "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": true, "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "abc123", + "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": "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": 123, - "check_money_order_title": "xyz789", - "cms_home_page": "abc123", - "cms_no_cookies": "abc123", - "cms_no_route": "abc123", + "check_money_order_sort_order": 987, + "check_money_order_title": "abc123", + "cms_home_page": "xyz789", + "cms_no_cookies": "xyz789", + "cms_no_route": "xyz789", "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", - "contact_enabled": true, + "configurable_thumbnail_source": "xyz789", + "contact_enabled": false, "copyright": "xyz789", "countries_with_required_region": "xyz789", "create_account_confirmation": true, - "customer_access_token_lifetime": 123.45, - "default_country": "abc123", + "customer_access_token_lifetime": 987.65, + "default_country": "xyz789", "default_description": "abc123", - "default_display_currency_code": "abc123", + "default_display_currency_code": "xyz789", "default_keywords": "abc123", "default_title": "xyz789", "demonotice": 987, - "display_product_prices_in_catalog": 123, + "display_product_prices_in_catalog": 987, "display_shipping_prices": 987, - "display_state_if_optional": false, - "enable_multiple_wishlists": "xyz789", + "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_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": 123, + "fixed_product_taxes_display_prices_in_sales_modules": 123, + "fixed_product_taxes_display_prices_on_product_view_page": 987, "fixed_product_taxes_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "xyz789", - "graphql_share_customer_group": true, + "graphql_share_customer_group": false, "grid_per_page": 987, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", "head_includes": "xyz789", "head_shortcut_icon": "abc123", "header_logo_src": "abc123", - "id": 123, - "is_checkout_agreements_enabled": false, + "id": 987, + "is_checkout_agreements_enabled": true, "is_default_store": true, "is_default_store_group": true, "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": 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": "xyz789", + "list_per_page": 123, + "list_per_page_values": "abc123", "locale": "xyz789", - "logo_alt": "abc123", - "logo_height": 123, + "logo_alt": "xyz789", + "logo_height": 987, "logo_width": 987, "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": "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": "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_order": "xyz789", + "magento_reward_points_register": "abc123", + "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", "magento_wishlist_general_is_enabled": "xyz789", "max_items_in_order_summary": 987, @@ -3889,63 +3889,63 @@ Contains information about a store's configuration. "minicart_display": false, "minicart_max_items": 987, "minimum_password_length": "xyz789", - "newsletter_enabled": false, - "no_route": "abc123", + "newsletter_enabled": true, + "no_route": "xyz789", "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": true, - "orders_invoices_credit_memos_display_grandtotal": true, + "orders_invoices_credit_memos_display_grandtotal": false, "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_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": "abc123", - "quickorder_active": true, - "required_character_classes_number": "xyz789", + "product_url_suffix": "xyz789", + "quickorder_active": false, + "required_character_classes_number": "abc123", "returns_enabled": "xyz789", - "root_category_id": 123, - "root_category_uid": "4", + "root_category_id": 987, + "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "abc123", - "sales_printed_card": "abc123", + "sales_printed_card": "xyz789", "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, "share_active_segments": false, "share_applied_cart_rule": true, - "shopping_cart_display_full_summary": true, + "shopping_cart_display_full_summary": false, "shopping_cart_display_grand_total": false, "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 987, + "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, - "show_cms_breadcrumbs": 123, + "show_cms_breadcrumbs": 987, "store_code": "4", "store_group_code": 4, "store_group_name": "xyz789", - "store_name": "xyz789", - "store_sort_order": 123, - "timezone": "xyz789", - "title_prefix": "abc123", + "store_name": "abc123", + "store_sort_order": 987, + "timezone": "abc123", + "title_prefix": "xyz789", "title_separator": "abc123", - "title_suffix": "xyz789", - "use_store_in_url": true, + "title_suffix": "abc123", + "use_store_in_url": false, "website_code": 4, - "website_id": 987, - "website_name": "xyz789", - "weight_unit": "abc123", - "welcome": "xyz789", + "website_id": 123, + "website_name": "abc123", + "weight_unit": "xyz789", + "welcome": "abc123", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": false, + "zero_subtotal_enabled": true, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "abc123", "zero_subtotal_payment_from_specific_countries": "abc123", @@ -3964,20 +3964,20 @@ Indicates where an attribute can be displayed. | 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. | +| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example ```json { - "position": 123, + "position": 987, "use_in_layered_navigation": "NO", - "use_in_product_listing": true, - "use_in_search_results_layered_navigation": false, + "use_in_product_listing": false, + "use_in_search_results_layered_navigation": true, "visible_on_catalog_pages": true } ``` @@ -3993,7 +3993,7 @@ represent free-form human-readable text. #### Example ```json -"xyz789" +"abc123" ``` @@ -4007,18 +4007,18 @@ Specifies the quote template properties to update. | 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 | +| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](types-f-i.md#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. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "comment": "abc123", - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "reference_document_links": [ @@ -4084,7 +4084,7 @@ Describes the swatch type and a value. ```json { - "type": "abc123", + "type": "xyz789", "value": "abc123" } ``` @@ -4103,9 +4103,9 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | +| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | #### Example @@ -4156,7 +4156,7 @@ Swatch attribute metadata input types. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](types-f-i.md#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.)* | @@ -4166,7 +4166,7 @@ Swatch attribute metadata input types. ```json { "items_count": 987, - "label": "abc123", + "label": "xyz789", "swatch_data": SwatchData, "value_string": "xyz789" } @@ -4211,8 +4211,8 @@ Synchronizes the payment order details ```json { - "cartId": "abc123", - "id": "xyz789" + "cartId": "xyz789", + "id": "abc123" } ``` 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 index cee58c94a..7472e77f3 100644 --- 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 @@ -8,16 +8,16 @@ Contains tax item details. | 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. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | #### Example ```json { "amount": Money, - "rate": 987.65, + "rate": 123.45, "title": "xyz789" } ``` @@ -48,7 +48,7 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -86,9 +86,9 @@ Defines a price based on the quantity purchased. | 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. | +| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -96,7 +96,7 @@ Defines a price based on the quantity purchased. { "discount": ProductDiscount, "final_price": Money, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -110,14 +110,14 @@ Modifies the specified items in the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [CartItemUpdateInput] } ``` @@ -132,8 +132,8 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | #### Example @@ -154,7 +154,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -172,7 +172,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -190,7 +190,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -208,7 +208,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -226,7 +226,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | +| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | #### Example @@ -244,12 +244,12 @@ Defines updates to a `GiftRegistry` object. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -258,7 +258,7 @@ Defines updates to a `GiftRegistry` object. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "abc123", + "event_name": "xyz789", "message": "abc123", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, @@ -276,17 +276,17 @@ Defines updates to an item in a gift registry. | 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. | +| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { - "gift_registry_item_uid": "4", - "note": "xyz789", - "quantity": 987.65 + "gift_registry_item_uid": 4, + "note": "abc123", + "quantity": 123.45 } ``` @@ -300,7 +300,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -318,7 +318,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -336,11 +336,11 @@ Defines updates to an existing registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -366,7 +366,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -384,7 +384,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -402,8 +402,8 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -424,7 +424,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -442,15 +442,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": 4 + "template_id": "4" } ``` @@ -486,25 +486,25 @@ Defines the changes to be made to an approval rule. | 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. | +| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { - "applies_to": [4], - "approvers": [4], + "applies_to": ["4"], + "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "abc123", "name": "xyz789", "status": "ENABLED", - "uid": "4" + "uid": 4 } ``` @@ -518,8 +518,8 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | +| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | #### Example @@ -540,10 +540,10 @@ Defines which items in a requisition list to update. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | #### Example @@ -566,7 +566,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -584,7 +584,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -602,16 +602,16 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](types-f-i.md#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, + "name": "xyz789", + "uid": "4", "visibility": "PUBLIC" } ``` @@ -626,8 +626,8 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](types-q-s.md#string) | The request URL. | #### Example @@ -688,16 +688,16 @@ Defines the input for returning matching companies the customer is assigned to. | 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. | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example ```json { - "currentPage": 987, - "pageSize": 987, + "currentPage": 123, + "pageSize": 123, "sort": [CompaniesSortInput] } ``` @@ -712,8 +712,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -734,7 +734,7 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example @@ -773,12 +773,12 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -792,7 +792,7 @@ Contains the results of validation attempts. | 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. | +| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -814,7 +814,7 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](#string) | Validation rule value. | +| `value` - [`String`](types-q-s.md#string) | Validation rule value. | #### Example @@ -877,8 +877,8 @@ Retrieves the vault configuration | Field Name | Description | |------------|-------------| -| `is_vault_enabled` - [`Boolean`](#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The parameters required to load the Paypal JS SDK | +| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | | `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | #### Example @@ -901,18 +901,18 @@ Vault payment inputs | 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. | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123", + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "xyz789", "public_hash": "abc123" } ``` @@ -927,7 +927,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](#paymentsourceinput) | The payment source information | +| `payment_source` - [`PaymentSourceInput!`](types-k-p.md#paymentsourceinput) | The payment source information | #### Example @@ -945,7 +945,7 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | #### Example @@ -963,20 +963,20 @@ An implementation for virtual product cart items. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -985,17 +985,17 @@ An implementation for virtual product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "xyz789", - "is_available": true, - "max_qty": 123.45, - "min_qty": 987.65, + "id": "abc123", + "is_available": false, + "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 + "quantity": 123.45, + "uid": "4" } ``` @@ -1009,83 +1009,83 @@ Defines a virtual product, which is a non-tangible product that does not require | 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 | +| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](types-k-p.md#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.)* | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#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)* | +| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](types-q-s.md#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 | +| `url_suffix` - [`String`](types-q-s.md#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", + "attribute_set_id": 987, + "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 123, + "color": 987, "country_of_manufacture": "abc123", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, "id": 123, @@ -1095,21 +1095,21 @@ Defines a virtual product, which is a non-tangible product that does not require "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "xyz789", + "meta_title": "xyz789", + "min_sale_qty": 123.45, + "name": "abc123", "new_from_date": "abc123", "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "rating_summary": 987.65, "redirect_code": 987, "related_products": [ProductInterface], @@ -1119,9 +1119,9 @@ Defines a virtual product, which is a non-tangible product that does not require "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "xyz789", + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "abc123", "staged": true, "stock_status": "IN_STOCK", "swatch_image": "abc123", @@ -1134,7 +1134,7 @@ Defines a virtual product, which is a non-tangible product that does not require "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", - "url_path": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website] @@ -1151,8 +1151,8 @@ 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. | +| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -1173,10 +1173,10 @@ Contains details about virtual products added to a requisition list. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1199,23 +1199,23 @@ Contains a virtual product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1229,21 +1229,21 @@ Deprecated. It should not be used on the storefront. Contains information about | 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.)* | +| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](types-q-s.md#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`](types-f-i.md#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, + "code": "xyz789", + "default_group_id": "abc123", + "id": 123, + "is_default": false, "name": "xyz789", "sort_order": 987 } @@ -1260,14 +1260,14 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -1300,13 +1300,13 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](types-f-i.md#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_count` - [`Int`](types-f-i.md#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. | +| `name` - [`String`](types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -1315,11 +1315,11 @@ Contains a customer wish list. { "id": "4", "items": [WishlistItem], - "items_count": 123, + "items_count": 987, "items_v2": WishlistItems, "name": "xyz789", "sharing_code": "xyz789", - "updated_at": "xyz789", + "updated_at": "abc123", "visibility": "PUBLIC" } ``` @@ -1335,18 +1335,18 @@ Contains details about errors encountered when a customer added wish list items | 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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "wishlistId": 4, - "wishlistItemId": "4" + "message": "xyz789", + "wishlistId": "4", + "wishlistItemId": 4 } ``` @@ -1382,19 +1382,19 @@ Contains details about a wish list item. | 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 | +| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { "added_at": "abc123", - "description": "abc123", - "id": 123, + "description": "xyz789", + "id": 987, "product": ProductInterface, "qty": 123.45 } @@ -1410,16 +1410,13 @@ Specifies the IDs of items to copy and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json -{ - "quantity": 987.65, - "wishlist_item_id": "4" -} +{"quantity": 123.45, "wishlist_item_id": 4} ``` @@ -1432,21 +1429,21 @@ Defines the items to add to a wish list. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](types-q-s.md#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", + "parent_sku": "xyz789", "quantity": 987.65, - "selected_options": [4], - "sku": "xyz789" + "selected_options": ["4"], + "sku": "abc123" } ``` @@ -1460,24 +1457,24 @@ The interface for wish list items. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | +| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | +| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | +| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | #### Example @@ -1486,9 +1483,9 @@ The interface for wish list items. "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1502,16 +1499,13 @@ Specifies the IDs of the items to move and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json -{ - "quantity": 987.65, - "wishlist_item_id": "4" -} +{"quantity": 987.65, "wishlist_item_id": 4} ``` @@ -1524,19 +1518,19 @@ Defines updates to items in a wish list. | 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. | +| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "entered_options": [EnteredOptionInput], - "quantity": 123.45, + "quantity": 987.65, "selected_options": [4], "wishlist_item_id": 4 } @@ -1553,7 +1547,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1575,20 +1569,20 @@ Deprecated: Use the `Wishlist` type instead. | 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.)* | +| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](types-q-s.md#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, + "items_count": 987, "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "xyz789" + "sharing_code": "abc123", + "updated_at": "abc123" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md index 1b31c6988..62fca9473 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": false}}} +{"data": {"acceptCompanyInvitation": {"success": true}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -115,29 +115,29 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "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, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 123.45, - "uid": 4, + "template_id": "4", + "total_quantity": 987.65, + "uid": "4", "updated_at": "abc123" } } @@ -150,13 +150,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -194,14 +194,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -250,14 +250,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -310,13 +310,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -364,13 +364,13 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Creates a new cart and add any type of product to it -**Response:** [`AddProductsToNewCartOutput`](#addproductstonewcartoutput) +**Response:** [`AddProductsToNewCartOutput`](types-a-b.md#addproductstonewcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartItems` - [`[CartItemInput!]!`](#cartiteminput) | An array that defines the products to add to the new cart | +| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the new cart | #### Example @@ -414,14 +414,14 @@ mutation addProductsToNewCart($cartItems: [CartItemInput!]!) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -447,7 +447,7 @@ mutation addProductsToRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [RequisitionListItemsInput] } ``` @@ -470,14 +470,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -505,7 +505,10 @@ mutation addProductsToWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} +{ + "wishlistId": "4", + "wishlistItems": [WishlistItemInput] +} ``` ##### Response @@ -527,13 +530,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -573,13 +576,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -623,14 +626,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -660,7 +663,7 @@ mutation addRequisitionListItemsToCart( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItemUids": ["4"] } ``` @@ -675,7 +678,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } } } @@ -687,13 +690,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -727,13 +730,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -777,14 +780,14 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -813,10 +816,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemIds": ["4"] -} +{"wishlistId": 4, "wishlistItemIds": ["4"]} ``` ##### Response @@ -841,13 +841,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -881,13 +881,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -921,13 +921,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -961,13 +961,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -1001,13 +1001,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1041,13 +1041,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1091,13 +1091,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign a child company to a parent company within the company relation hierarchy. -**Response:** [`AssignChildCompanyOutput`](#assignchildcompanyoutput) +**Response:** [`AssignChildCompanyOutput`](types-a-b.md#assignchildcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AssignChildCompanyInput!`](#assignchildcompanyinput) | An input object that defines which companies to relate. | +| `input` - [`AssignChildCompanyInput!`](types-a-b.md#assignchildcompanyinput) | An input object that defines which companies to relate. | #### Example @@ -1137,13 +1137,13 @@ mutation assignChildCompany($input: AssignChildCompanyInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1185,13 +1185,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | | +| `cart_id` - [`String!`](types-q-s.md#string) | | #### Example @@ -1258,7 +1258,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` ##### Response @@ -1279,17 +1279,17 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "custom_attributes": [CustomAttribute], "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": true, + "id": 4, + "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1301,13 +1301,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1378,10 +1378,10 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "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": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -1389,15 +1389,15 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45, - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } } } @@ -1409,13 +1409,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | #### Example @@ -1447,7 +1447,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1461,13 +1461,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1511,14 +1511,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | #### Example @@ -1655,36 +1655,36 @@ mutation changeCustomerPassword( "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "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", "default_billing": "xyz789", - "default_shipping": "abc123", - "email": "xyz789", - "firstname": "xyz789", + "default_shipping": "xyz789", + "email": "abc123", + "firstname": "abc123", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": 4, "is_subscribed": false, - "job_title": "abc123", - "lastname": "abc123", + "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": false, - "quote_enabled": true, + "purchase_orders_enabled": true, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1693,11 +1693,11 @@ mutation changeCustomerPassword( "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -1711,13 +1711,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1756,13 +1756,13 @@ mutation clearCustomerCart($cartUid: String!) { Remove all the products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | #### Example @@ -1784,7 +1784,7 @@ mutation clearWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -1806,13 +1806,13 @@ mutation clearWishlist($wishlistId: ID!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1865,13 +1865,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Synchronizes order details and place the order -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompleteOrderInput`](#completeorderinput) | Describes the variables needed to complete or place the order | +| `input` - [`CompleteOrderInput`](types-c-e.md#completeorderinput) | Describes the variables needed to complete or place the order | #### Example @@ -1915,13 +1915,13 @@ mutation completeOrder($input: CompleteOrderInput) { Cancel the specified guest customer order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmCancelOrderInput!`](#confirmcancelorderinput) | | +| `input` - [`ConfirmCancelOrderInput!`](types-c-e.md#confirmcancelorderinput) | | #### Example @@ -1967,13 +1967,13 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -2007,13 +2007,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Confirm the return. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmReturnInput!`](#confirmreturninput) | | +| `input` - [`ConfirmReturnInput!`](types-c-e.md#confirmreturninput) | | #### Example @@ -2057,13 +2057,13 @@ mutation confirmReturn($input: ConfirmReturnInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](#contactusoutput) +**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -2086,7 +2086,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": true}}} +{"data": {"contactUs": {"status": false}}} ``` @@ -2095,15 +2095,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2131,8 +2131,8 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": "4", + "sourceRequisitionListUid": 4, + "destinationRequisitionListUid": 4, "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2155,15 +2155,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2197,7 +2197,7 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, + "sourceWishlistUid": "4", "destinationWishlistUid": "4", "wishlistItems": [WishlistItemCopyInput] } @@ -2223,13 +2223,13 @@ mutation copyProductsBetweenWishlists( Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | #### Example @@ -2263,13 +2263,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | #### Example @@ -2303,13 +2303,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | #### Example @@ -2343,13 +2343,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | #### Example @@ -2383,13 +2383,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | #### Example @@ -2425,7 +2425,7 @@ mutation createCompareList($input: CreateCompareListInput) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -2437,13 +2437,13 @@ mutation createCompareList($input: CreateCompareListInput) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | #### Example @@ -2499,22 +2499,22 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, - "default_shipping": true, + "default_billing": false, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", "firstname": "xyz789", - "id": 123, - "lastname": "xyz789", - "middlename": "xyz789", + "id": 987, + "lastname": "abc123", + "middlename": "abc123", "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", + "telephone": "xyz789", + "uid": 4, "vat_id": "abc123" } } @@ -2527,13 +2527,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2567,13 +2567,13 @@ mutation createCustomerV2($input: CustomerCreateInput!) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2611,13 +2611,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | #### Example @@ -2651,13 +2651,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -2688,7 +2688,7 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { "data": { "createPaymentOrder": { "amount": 123.45, - "currency_code": "abc123", + "currency_code": "xyz789", "id": "xyz789", "mp_order_id": "abc123", "status": "xyz789" @@ -2703,13 +2703,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -2754,12 +2754,12 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", - "created_by": "xyz789", - "description": "abc123", - "name": "xyz789", + "created_by": "abc123", + "description": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } } } @@ -2771,13 +2771,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | #### Example @@ -2817,13 +2817,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Creates a vault payment token -**Response:** [`CreateVaultCardPaymentTokenOutput`](#createvaultcardpaymenttokenoutput) +**Response:** [`CreateVaultCardPaymentTokenOutput`](types-c-e.md#createvaultcardpaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardPaymentTokenInput!`](#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | +| `input` - [`CreateVaultCardPaymentTokenInput!`](types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | #### Example @@ -2853,7 +2853,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } } } @@ -2865,13 +2865,13 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) Creates a vault card setup token -**Response:** [`CreateVaultCardSetupTokenOutput`](#createvaultcardsetuptokenoutput) +**Response:** [`CreateVaultCardSetupTokenOutput`](types-c-e.md#createvaultcardsetuptokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardSetupTokenInput!`](#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | +| `input` - [`CreateVaultCardSetupTokenInput!`](types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | #### Example @@ -2897,7 +2897,7 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { { "data": { "createVaultCardSetupToken": { - "setup_token": "abc123" + "setup_token": "xyz789" } } } @@ -2909,13 +2909,13 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -2949,13 +2949,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -2972,7 +2972,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -2987,13 +2987,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3010,7 +3010,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3025,13 +3025,13 @@ mutation deleteCompanyTeam($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Example @@ -3048,7 +3048,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3063,13 +3063,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3086,7 +3086,7 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -3101,7 +3101,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Example @@ -3129,13 +3129,13 @@ Use `deleteCustomerAddressV2` instead. Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3156,7 +3156,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": false}} +{"data": {"deleteCustomerAddress": true}} ``` @@ -3165,13 +3165,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the customer address to be deleted. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address to be deleted. | #### Example @@ -3186,7 +3186,7 @@ mutation deleteCustomerAddressV2($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -3201,13 +3201,13 @@ mutation deleteCustomerAddressV2($uid: ID!) { Delete a negotiable quote template -**Response:** [`Boolean!`](#boolean) +**Response:** [`Boolean!`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3237,13 +3237,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3296,13 +3296,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3322,7 +3322,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "xyz789"} +{"public_hash": "abc123"} ``` ##### Response @@ -3344,13 +3344,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3390,13 +3390,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3416,7 +3416,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": 4} +{"requisitionListUid": "4"} ``` ##### Response @@ -3426,7 +3426,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { "data": { "deleteRequisitionList": { "requisition_lists": RequisitionLists, - "status": false + "status": true } } } @@ -3438,14 +3438,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -3491,13 +3491,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -3517,7 +3517,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": "4"} +{"wishlistId": 4} ``` ##### Response @@ -3539,13 +3539,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -3583,13 +3583,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -3636,11 +3636,11 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "additional_data": [ShippingAdditionalData], "amount": Money, "available": false, - "carrier_code": "xyz789", + "carrier_code": "abc123", "carrier_title": "xyz789", - "error_message": "abc123", + "error_message": "xyz789", "method_code": "abc123", - "method_title": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -3655,13 +3655,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -3695,13 +3695,13 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`ExchangeExternalCustomerTokenOutput`](#exchangeexternalcustomertokenoutput) +**Response:** [`ExchangeExternalCustomerTokenOutput`](types-c-e.md#exchangeexternalcustomertokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ExchangeExternalCustomerTokenInput`](#exchangeexternalcustomertokeninput) | Contains details about external customer. | +| `input` - [`ExchangeExternalCustomerTokenInput`](types-c-e.md#exchangeexternalcustomertokeninput) | Contains details about external customer. | #### Example @@ -3743,14 +3743,14 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu Exchange one time login code for customer token. -**Response:** [`CustomerToken`](#customertoken) +**Response:** [`CustomerToken`](types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `otp` - [`String!`](#string) | The customer's OTP. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `otp` - [`String!`](types-q-s.md#string) | The customer's OTP. | #### Example @@ -3775,7 +3775,7 @@ mutation exchangeOtpForCustomerToken( ```json { "email": "xyz789", - "otp": "xyz789" + "otp": "abc123" } ``` @@ -3795,13 +3795,13 @@ mutation exchangeOtpForCustomerToken( ### finishUpload -**Response:** [`finishUploadOutput`](#finishuploadoutput) +**Response:** [`finishUploadOutput`](types-f-i.md#finishuploadoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`finishUploadInput!`](#finishuploadinput) | | +| `input` - [`finishUploadInput!`](types-f-i.md#finishuploadinput) | | #### Example @@ -3830,8 +3830,8 @@ mutation finishUpload($input: finishUploadInput!) { "data": { "finishUpload": { "key": "xyz789", - "message": "abc123", - "success": false + "message": "xyz789", + "success": true } } } @@ -3843,14 +3843,14 @@ mutation finishUpload($input: finishUploadInput!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](#customertoken) +**Response:** [`CustomerToken`](types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -3897,13 +3897,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -3941,13 +3941,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -3985,13 +3985,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Import a shared requisition list into the current customer account. -**Response:** [`ImportSharedRequisitionListOutput`](#importsharedrequisitionlistoutput) +**Response:** [`ImportSharedRequisitionListOutput`](types-f-i.md#importsharedrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `token` - [`String!`](#string) | The token for the shared requisition list. | +| `token` - [`String!`](types-q-s.md#string) | The token for the shared requisition list. | #### Example @@ -4013,7 +4013,7 @@ mutation importSharedRequisitionList($token: String!) { ##### Variables ```json -{"token": "abc123"} +{"token": "xyz789"} ``` ##### Response @@ -4033,13 +4033,13 @@ mutation importSharedRequisitionList($token: String!) { ### initiateUpload -**Response:** [`initiateUploadOutput`](#initiateuploadoutput) +**Response:** [`initiateUploadOutput`](types-f-i.md#initiateuploadoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`initiateUploadInput!`](#initiateuploadinput) | | +| `input` - [`initiateUploadInput!`](types-f-i.md#initiateuploadinput) | | #### Example @@ -4067,9 +4067,9 @@ mutation initiateUpload($input: initiateUploadInput!) { { "data": { "initiateUpload": { - "expires_at": "xyz789", - "key": "xyz789", - "upload_url": "xyz789" + "expires_at": "abc123", + "key": "abc123", + "upload_url": "abc123" } } } @@ -4081,14 +4081,14 @@ mutation initiateUpload($input: initiateUploadInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `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. | +| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4163,7 +4163,7 @@ mutation mergeCarts( ```json { "source_cart_id": "xyz789", - "destination_cart_id": "xyz789" + "destination_cart_id": "abc123" } ``` @@ -4183,7 +4183,7 @@ mutation mergeCarts( ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, @@ -4195,7 +4195,7 @@ mutation mergeCarts( "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -4207,14 +4207,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4243,10 +4243,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{ - "cartUid": "4", - "giftRegistryUid": "4" -} +{"cartUid": "4", "giftRegistryUid": 4} ``` ##### Response @@ -4256,7 +4253,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } } @@ -4269,15 +4266,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4308,7 +4305,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, + "sourceRequisitionListUid": "4", "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } @@ -4333,13 +4330,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4379,15 +4376,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4422,7 +4419,7 @@ mutation moveProductsBetweenWishlists( ```json { "sourceWishlistUid": "4", - "destinationWishlistUid": 4, + "destinationWishlistUid": "4", "wishlistItems": [WishlistItemMoveInput] } ``` @@ -4447,13 +4444,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4521,13 +4518,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "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, + "max_order_commitment": 987, "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -4540,9 +4537,9 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", - "total_quantity": 987.65, - "uid": "4", + "template_id": 4, + "total_quantity": 123.45, + "uid": 4, "updated_at": "xyz789" } } @@ -4559,13 +4556,13 @@ Use placeNegotiableQuoteOrderV2 instead. Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4599,13 +4596,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutputV2`](#placenegotiablequoteorderoutputv2) +**Response:** [`PlaceNegotiableQuoteOrderOutputV2`](types-k-p.md#placenegotiablequoteorderoutputv2) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4649,13 +4646,13 @@ mutation placeNegotiableQuoteOrderV2($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](#placeorderoutput) +**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4699,13 +4696,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -4743,13 +4740,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | #### Example @@ -4789,13 +4786,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -4839,13 +4836,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | #### Example @@ -4889,13 +4886,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4929,13 +4926,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4969,13 +4966,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -5009,13 +5006,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -5032,13 +5029,13 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response ```json -{"data": {"removeGiftRegistry": {"success": false}}} +{"data": {"removeGiftRegistry": {"success": true}}} ``` @@ -5047,14 +5044,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -5103,14 +5100,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -5136,8 +5133,8 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, - "registrantsUid": ["4"] + "giftRegistryUid": "4", + "registrantsUid": [4] } ``` @@ -5159,13 +5156,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5199,13 +5196,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5245,13 +5242,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5318,30 +5315,30 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "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": 987, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", "template_id": "4", - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -5353,13 +5350,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5393,7 +5390,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -5407,14 +5404,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5442,7 +5439,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": "4", "wishlistItemsIds": [4]} +{"wishlistId": 4, "wishlistItemsIds": ["4"]} ``` ##### Response @@ -5464,13 +5461,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5504,13 +5501,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](#id) | | +| `cartId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -5529,7 +5526,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -5544,13 +5541,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5584,13 +5581,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5628,13 +5625,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](#string) | | +| `orderNumber` - [`String!`](types-q-s.md#string) | | #### Example @@ -5656,7 +5653,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "xyz789"} +{"orderNumber": "abc123"} ``` ##### Response @@ -5678,13 +5675,13 @@ mutation reorderItems($orderNumber: String!) { Request to cancel specified guest order. -**Response:** [`CancelOrderOutput`](#cancelorderoutput) +**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderCancelInput!`](#guestordercancelinput) | | +| `input` - [`GuestOrderCancelInput!`](types-f-i.md#guestordercancelinput) | | #### Example @@ -5728,13 +5725,13 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { ### requestGuestReturn -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestGuestReturnInput!`](#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | +| `input` - [`RequestGuestReturnInput!`](types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | #### Example @@ -5778,13 +5775,13 @@ mutation requestGuestReturn($input: RequestGuestReturnInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -5822,13 +5819,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -5895,15 +5892,15 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "requestNegotiableQuoteTemplateFromQuote": { "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": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -5915,8 +5912,8 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 987.65, + "template_id": "4", + "total_quantity": 123.45, "uid": 4, "updated_at": "xyz789" } @@ -5930,13 +5927,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | #### Example @@ -5951,13 +5948,13 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"requestPasswordResetEmail": true}} +{"data": {"requestPasswordResetEmail": false}} ``` @@ -5966,13 +5963,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](#requestreturnoutput) +**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -6016,13 +6013,13 @@ mutation requestReturn($input: RequestReturnInput!) { Resends the confirmation email to a customer. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to send the confirmation email to. | +| `email` - [`String!`](types-q-s.md#string) | The email address to send the confirmation email to. | #### Example @@ -6037,13 +6034,13 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"resendConfirmationEmail": false}} +{"data": {"resendConfirmationEmail": true}} ``` @@ -6052,15 +6049,15 @@ mutation resendConfirmationEmail($email: String!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | 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!`](types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | #### Example @@ -6085,7 +6082,7 @@ mutation resetPassword( ```json { "email": "xyz789", - "resetPasswordToken": "xyz789", + "resetPasswordToken": "abc123", "newPassword": "abc123" } ``` @@ -6093,7 +6090,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": false}} +{"data": {"resetPassword": true}} ``` @@ -6102,7 +6099,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) #### Example @@ -6128,13 +6125,13 @@ mutation revokeCustomerToken { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -6174,13 +6171,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -6214,13 +6211,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Sets the cart as inactive -**Response:** [`SetCartAsInactiveOutput`](#setcartasinactiveoutput) +**Response:** [`SetCartAsInactiveOutput`](types-q-s.md#setcartasinactiveoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | #### Example @@ -6238,7 +6235,7 @@ mutation setCartAsInactive($cartId: String!) { ##### Variables ```json -{"cartId": "xyz789"} +{"cartId": "abc123"} ``` ##### Response @@ -6248,7 +6245,7 @@ mutation setCartAsInactive($cartId: String!) { "data": { "setCartAsInactive": { "error": "abc123", - "success": true + "success": false } } } @@ -6260,13 +6257,13 @@ mutation setCartAsInactive($cartId: String!) { Add custom attributes to the cart. -**Response:** [`AddCustomAttributesToCartItemOutput`](#addcustomattributestocartitemoutput) +**Response:** [`AddCustomAttributesToCartItemOutput`](types-a-b.md#addcustomattributestocartitemoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CartCustomAttributesInput`](#cartcustomattributesinput) | | +| `input` - [`CartCustomAttributesInput`](types-c-e.md#cartcustomattributesinput) | | #### Example @@ -6300,13 +6297,13 @@ mutation setCustomAttributesOnCart($input: CartCustomAttributesInput) { Add custom attributes to item in the cart. -**Response:** [`AddCustomAttributesToCartItemOutput`](#addcustomattributestocartitemoutput) +**Response:** [`AddCustomAttributesToCartItemOutput`](types-a-b.md#addcustomattributestocartitemoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CartItemCustomAttributesInput`](#cartitemcustomattributesinput) | | +| `input` - [`CartItemCustomAttributesInput`](types-c-e.md#cartitemcustomattributesinput) | | #### Example @@ -6344,13 +6341,13 @@ mutation setCustomAttributesOnCartItem($input: CartItemCustomAttributesInput) { Add custom attributes to company. -**Response:** [`SetCustomAttributesOnCompanyOutput`](#setcustomattributesoncompanyoutput) +**Response:** [`SetCustomAttributesOnCompanyOutput`](types-q-s.md#setcustomattributesoncompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetCustomAttributesOnCompanyInput!`](#setcustomattributesoncompanyinput) | An input object that defines the custom attributes to be assigned to a company. | +| `input` - [`SetCustomAttributesOnCompanyInput!`](types-q-s.md#setcustomattributesoncompanyinput) | An input object that defines the custom attributes to be assigned to a company. | #### Example @@ -6388,13 +6385,13 @@ mutation setCustomAttributesOnCompany($input: SetCustomAttributesOnCompanyInput! Add custom attributes to the credit memo. -**Response:** [`CreditMemoOutput`](#creditmemooutput) +**Response:** [`CreditMemoOutput`](types-c-e.md#creditmemooutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreditMemoCustomAttributesInput`](#creditmemocustomattributesinput) | | +| `input` - [`CreditMemoCustomAttributesInput`](types-c-e.md#creditmemocustomattributesinput) | | #### Example @@ -6434,13 +6431,13 @@ mutation setCustomAttributesOnCreditMemo($input: CreditMemoCustomAttributesInput Add custom attributes to the credit memo item. -**Response:** [`CreditMemoOutput`](#creditmemooutput) +**Response:** [`CreditMemoOutput`](types-c-e.md#creditmemooutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreditMemoItemCustomAttributesInput`](#creditmemoitemcustomattributesinput) | | +| `input` - [`CreditMemoItemCustomAttributesInput`](types-c-e.md#creditmemoitemcustomattributesinput) | | #### Example @@ -6480,13 +6477,13 @@ mutation setCustomAttributesOnCreditMemoItem($input: CreditMemoItemCustomAttribu Add custom attributes to the invoice. -**Response:** [`InvoiceOutput`](#invoiceoutput) +**Response:** [`InvoiceOutput`](types-f-i.md#invoiceoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`InvoiceCustomAttributesInput`](#invoicecustomattributesinput) | | +| `input` - [`InvoiceCustomAttributesInput`](types-f-i.md#invoicecustomattributesinput) | | #### Example @@ -6524,13 +6521,13 @@ mutation setCustomAttributesOnInvoice($input: InvoiceCustomAttributesInput) { Add custom attributes to the invoice item. -**Response:** [`InvoiceOutput`](#invoiceoutput) +**Response:** [`InvoiceOutput`](types-f-i.md#invoiceoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`InvoiceItemCustomAttributesInput`](#invoiceitemcustomattributesinput) | | +| `input` - [`InvoiceItemCustomAttributesInput`](types-f-i.md#invoiceitemcustomattributesinput) | | #### Example @@ -6570,13 +6567,13 @@ mutation setCustomAttributesOnInvoiceItem($input: InvoiceItemCustomAttributesInp Add custom attributes to a negotiable quote. -**Response:** [`SetCustomAttributesOnNegotiableQuoteOutput`](#setcustomattributesonnegotiablequoteoutput) +**Response:** [`SetCustomAttributesOnNegotiableQuoteOutput`](types-q-s.md#setcustomattributesonnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetCustomAttributesOnNegotiableQuoteInput!`](#setcustomattributesonnegotiablequoteinput) | An input object that defines the custom attributes to be assigned to a negotiable quote. | +| `input` - [`SetCustomAttributesOnNegotiableQuoteInput!`](types-q-s.md#setcustomattributesonnegotiablequoteinput) | An input object that defines the custom attributes to be assigned to a negotiable quote. | #### Example @@ -6616,13 +6613,13 @@ mutation setCustomAttributesOnNegotiableQuote($input: SetCustomAttributesOnNegot Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -6656,13 +6653,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6696,13 +6693,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6736,13 +6733,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6782,13 +6779,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6828,13 +6825,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6874,13 +6871,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6920,13 +6917,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6997,26 +6994,26 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "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, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, - "total_quantity": 987.65, - "uid": 4, - "updated_at": "abc123" + "template_id": "4", + "total_quantity": 123.45, + "uid": "4", + "updated_at": "xyz789" } } } @@ -7028,13 +7025,13 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -7068,13 +7065,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Set expiration date to a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateExpirationDateInput!`](#quotetemplateexpirationdateinput) | An input object that defines the quote template expiration date. | +| `input` - [`QuoteTemplateExpirationDateInput!`](types-q-s.md#quotetemplateexpirationdateinput) | An input object that defines the quote template expiration date. | #### Example @@ -7141,12 +7138,12 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "setQuoteTemplateExpirationDate": { "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_min_max_qty_used": true, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 123, @@ -7160,7 +7157,7 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", "total_quantity": 123.45, "uid": 4, @@ -7176,13 +7173,13 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -7256,9 +7253,9 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 987, + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -7268,8 +7265,8 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, + "status": "abc123", + "template_id": "4", "total_quantity": 123.45, "uid": 4, "updated_at": "xyz789" @@ -7284,13 +7281,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -7324,13 +7321,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -7364,15 +7361,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7398,7 +7395,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7407,7 +7404,7 @@ mutation shareGiftRegistry( ##### Response ```json -{"data": {"shareGiftRegistry": {"is_shared": true}}} +{"data": {"shareGiftRegistry": {"is_shared": false}}} ``` @@ -7416,13 +7413,13 @@ mutation shareGiftRegistry( Share a requisition list with company colleagues via email using a secure link. -**Response:** [`ShareRequisitionListByEmailOutput`](#sharerequisitionlistbyemailoutput) +**Response:** [`ShareRequisitionListByEmailOutput`](types-q-s.md#sharerequisitionlistbyemailoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ShareRequisitionListByEmailInput!`](#sharerequisitionlistbyemailinput) | | +| `input` - [`ShareRequisitionListByEmailInput!`](types-q-s.md#sharerequisitionlistbyemailinput) | | #### Example @@ -7451,7 +7448,7 @@ mutation shareRequisitionListByEmail($input: ShareRequisitionListByEmailInput!) { "data": { "shareRequisitionListByEmail": { - "sent_count": 123, + "sent_count": 987, "user_errors": [ShareRequisitionListUserError] } } @@ -7464,13 +7461,13 @@ mutation shareRequisitionListByEmail($input: ShareRequisitionListByEmailInput!) Share a requisition list by issuing a token for colleagues in the same company. Use the token to build a shareable link on the storefront. -**Response:** [`ShareRequisitionListByTokenOutput`](#sharerequisitionlistbytokenoutput) +**Response:** [`ShareRequisitionListByTokenOutput`](types-q-s.md#sharerequisitionlistbytokenoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -7487,7 +7484,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": 4} +{"requisitionListUid": "4"} ``` ##### Response @@ -7496,7 +7493,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { { "data": { "shareRequisitionListByToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -7508,13 +7505,13 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -7585,10 +7582,10 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "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": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -7596,14 +7593,14 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, "total_quantity": 123.45, - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -7616,13 +7613,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -7639,7 +7636,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -7654,13 +7651,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Subscribe logged-in customer to price alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertPriceInput!`](#productalertpriceinput) | | +| `input` - [`ProductAlertPriceInput!`](types-k-p.md#productalertpriceinput) | | #### Example @@ -7700,13 +7697,13 @@ mutation subscribeProductAlertPrice($input: ProductAlertPriceInput!) { Subscribe logged-in customer to stock alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertStockInput!`](#productalertstockinput) | | +| `input` - [`ProductAlertStockInput!`](types-k-p.md#productalertstockinput) | | #### Example @@ -7733,7 +7730,7 @@ mutation subscribeProductAlertStock($input: ProductAlertStockInput!) { { "data": { "subscribeProductAlertStock": { - "message": "xyz789", + "message": "abc123", "success": false } } @@ -7746,13 +7743,13 @@ mutation subscribeProductAlertStock($input: ProductAlertStockInput!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](#boolean) +**Response:** [`Boolean`](types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -7782,13 +7779,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Unassign a child company from its parent company within the company relation hierarchy. -**Response:** [`UnassignChildCompanyOutput`](#unassignchildcompanyoutput) +**Response:** [`UnassignChildCompanyOutput`](types-t-z.md#unassignchildcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UnassignChildCompanyInput!`](#unassignchildcompanyinput) | An input object that defines which company to unassign. | +| `input` - [`UnassignChildCompanyInput!`](types-t-z.md#unassignchildcompanyinput) | An input object that defines which company to unassign. | #### Example @@ -7828,13 +7825,13 @@ mutation unassignChildCompany($input: UnassignChildCompanyInput!) { Unsubscribe logged-in customer to price alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertPriceInput!`](#productalertpriceinput) | | +| `input` - [`ProductAlertPriceInput!`](types-k-p.md#productalertpriceinput) | | #### Example @@ -7874,7 +7871,7 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { Unsubscribe logged-in customer to price alert for all product. -**Response:** [`ProductAlertSubscriptionResult`](#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) #### Example @@ -7895,8 +7892,8 @@ mutation unsubscribeProductAlertPriceAll { { "data": { "unsubscribeProductAlertPriceAll": { - "message": "abc123", - "success": false + "message": "xyz789", + "success": true } } } @@ -7908,13 +7905,13 @@ mutation unsubscribeProductAlertPriceAll { Unsubscribe logged-in customer to stock alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertStockInput!`](#productalertstockinput) | | +| `input` - [`ProductAlertStockInput!`](types-k-p.md#productalertstockinput) | | #### Example @@ -7942,7 +7939,7 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { "data": { "unsubscribeProductAlertStock": { "message": "xyz789", - "success": true + "success": false } } } @@ -7954,7 +7951,7 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { Unsubscribe logged-in customer to stock alert for all product. -**Response:** [`ProductAlertSubscriptionResult`](#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) #### Example @@ -7988,13 +7985,13 @@ mutation unsubscribeProductAlertStockAll { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -8038,13 +8035,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | #### Example @@ -8078,13 +8075,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | #### Example @@ -8118,13 +8115,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | #### Example @@ -8158,13 +8155,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | #### Example @@ -8198,13 +8195,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | #### Example @@ -8242,14 +8239,14 @@ Use `updateCustomerAddressV2` instead. Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -8298,7 +8295,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 987, "input": CustomerAddressInput} +{"id": 123, "input": CustomerAddressInput} ``` ##### Response @@ -8317,15 +8314,15 @@ mutation updateCustomerAddress( "fax": "xyz789", "firstname": "xyz789", "id": 987, - "lastname": "abc123", - "middlename": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "abc123", - "telephone": "xyz789", + "telephone": "abc123", "uid": "4", "vat_id": "abc123" } @@ -8339,14 +8336,14 @@ mutation updateCustomerAddress( Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](#customeraddress) +**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the customer address. | -| `input` - [`CustomerAddressInput`](#customeraddressinput) | An input object that contains changes to the customer address. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address. | +| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -8395,10 +8392,7 @@ mutation updateCustomerAddressV2( ##### Variables ```json -{ - "uid": "4", - "input": CustomerAddressInput -} +{"uid": 4, "input": CustomerAddressInput} ``` ##### Response @@ -8408,23 +8402,23 @@ mutation updateCustomerAddressV2( "data": { "updateCustomerAddressV2": { "city": "abc123", - "company": "abc123", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": false, - "default_shipping": false, + "default_billing": true, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "xyz789", "id": 987, "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 987, "street": ["xyz789"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", "uid": 4, "vat_id": "xyz789" @@ -8439,14 +8433,14 @@ mutation updateCustomerAddressV2( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](types-q-s.md#string) | The customer's password. | #### Example @@ -8472,8 +8466,8 @@ mutation updateCustomerEmail( ```json { - "email": "abc123", - "password": "abc123" + "email": "xyz789", + "password": "xyz789" } ``` @@ -8489,13 +8483,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](#customeroutput) +**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -8529,14 +8523,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -8583,14 +8577,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -8639,14 +8633,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -8695,13 +8689,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -8741,13 +8735,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -8787,14 +8781,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -8823,7 +8817,7 @@ mutation updateProductsInWishlist( ```json { - "wishlistId": 4, + "wishlistId": "4", "wishlistItems": [WishlistItemUpdateInput] } ``` @@ -8847,13 +8841,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -8897,13 +8891,13 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "abc123", - "description": "xyz789", + "created_at": "xyz789", + "created_by": "xyz789", + "description": "abc123", "name": "abc123", "status": "ENABLED", "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -8915,14 +8909,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -8971,14 +8965,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -9029,15 +9023,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](#id) | The ID of the wish list to update. | -| `name` - [`String`](#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -9091,13 +9085,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-saas-queries.md b/src/pages/includes/autogenerated/graphql-api-saas-queries.md index c210334f1..07e189457 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-queries.md @@ -20,7 +20,7 @@ SaaS Return a list of product attribute codes that can be used for sorting or filtering in a `productSearch` query -**Response:** [`AttributeMetadataResponse!`](#attributemetadataresponse) +**Response:** [`AttributeMetadataResponse!`](types-a-b.md#attributemetadataresponse) #### Example @@ -58,13 +58,13 @@ query attributeMetadata { Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](#attributesformoutput) +**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](#string) | Form code. | +| `formCode` - [`String!`](types-q-s.md#string) | Form code. | #### Example @@ -86,7 +86,7 @@ query attributesForm($formCode: String!) { ##### Variables ```json -{"formCode": "xyz789"} +{"formCode": "abc123"} ``` ##### Response @@ -108,14 +108,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -168,13 +168,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](#storeconfig) +**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -340,7 +340,7 @@ query availableStores($useCurrentGroup: Boolean) { ##### Variables ```json -{"useCurrentGroup": true} +{"useCurrentGroup": false} ``` ##### Response @@ -351,35 +351,35 @@ query availableStores($useCurrentGroup: Boolean) { "availableStores": [ { "allow_company_registration": false, - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "xyz789", "allow_items": "xyz789", "allow_order": "xyz789", "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_link_url": "xyz789", - "base_media_url": "xyz789", - "base_static_url": "abc123", - "base_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "xyz789", + "base_url": "abc123", "cart_expires_in_days": 123, - "cart_gift_wrapping": "abc123", + "cart_gift_wrapping": "xyz789", "cart_merge_preference": "xyz789", "cart_printed_card": "abc123", "cart_summary_display_quantity": 987, "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "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": "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_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 123, + "check_money_order_sort_order": 987, "check_money_order_title": "abc123", "company_credit_enabled": true, "company_enabled": true, @@ -387,21 +387,21 @@ query availableStores($useCurrentGroup: Boolean) { "configurable_thumbnail_source": "abc123", "contact_enabled": true, "countries_with_required_region": "abc123", - "create_account_confirmation": false, - "customer_access_token_lifetime": 987.65, + "create_account_confirmation": true, + "customer_access_token_lifetime": 123.45, "default_country": "xyz789", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "display_product_prices_in_catalog": 987, - "display_shipping_prices": 123, - "display_state_if_optional": false, + "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": 987, - "fixed_product_taxes_display_prices_in_sales_modules": 987, + "fixed_product_taxes_display_prices_in_product_lists": 123, + "fixed_product_taxes_display_prices_in_sales_modules": 123, "fixed_product_taxes_display_prices_on_product_view_page": 123, - "fixed_product_taxes_enable": true, - "fixed_product_taxes_include_fpt_in_subtotal": true, + "fixed_product_taxes_enable": false, + "fixed_product_taxes_include_fpt_in_subtotal": false, "graphql_share_customer_group": false, "grid_per_page": 123, "grid_per_page_values": "xyz789", @@ -413,91 +413,91 @@ query availableStores($useCurrentGroup: Boolean) { "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, "is_requisition_list_active": "abc123", - "list_mode": "xyz789", + "list_mode": "abc123", "list_per_page": 987, "list_per_page_values": "xyz789", "locale": "xyz789", - "magento_reward_general_is_enabled": "xyz789", + "magento_reward_general_is_enabled": "abc123", "magento_reward_general_is_enabled_on_front": "abc123", - "magento_reward_general_min_points_balance": "abc123", - "magento_reward_general_publish_history": "abc123", - "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "xyz789", - "magento_reward_points_invitation_order": "abc123", + "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_publish_history": "xyz789", + "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "abc123", + "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "abc123", "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "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": "xyz789", "minicart_display": true, - "minicart_max_items": 987, - "minimum_password_length": "xyz789", + "minicart_max_items": 123, + "minimum_password_length": "abc123", "newsletter_enabled": true, - "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": false, "order_cancellation_reasons": [ CancellationReason ], "orders_invoices_credit_memos_display_full_summary": false, - "orders_invoices_credit_memos_display_grandtotal": false, - "orders_invoices_credit_memos_display_price": 987, - "orders_invoices_credit_memos_display_shipping_amount": 123, - "orders_invoices_credit_memos_display_subtotal": 987, - "orders_invoices_credit_memos_display_zero_tax": false, + "orders_invoices_credit_memos_display_grandtotal": true, + "orders_invoices_credit_memos_display_price": 123, + "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_zero_tax": true, "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_url_suffix": "xyz789", - "quickorder_active": true, + "quickorder_active": false, "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "xyz789", - "required_character_classes_number": "xyz789", + "required_character_classes_number": "abc123", "requisition_list_share_link_validity_days": 987, - "requisition_list_share_max_recipients": 987, + "requisition_list_share_max_recipients": 123, "requisition_list_share_storefront_path": "xyz789", "requisition_list_sharing_enabled": false, - "returns_enabled": "xyz789", - "root_category_uid": "4", + "returns_enabled": "abc123", + "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "xyz789", "sales_printed_card": "abc123", "secure_base_link_url": "xyz789", - "secure_base_media_url": "xyz789", - "secure_base_static_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": "abc123", + "share_active_segments": false, + "share_applied_cart_rule": true, + "shopping_assistance_checkbox_title": "xyz789", "shopping_assistance_checkbox_tooltip": "xyz789", - "shopping_assistance_enabled": true, - "shopping_cart_display_full_summary": false, + "shopping_assistance_enabled": false, + "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_subtotal": 987, + "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, - "store_code": 4, - "store_group_code": 4, + "store_code": "4", + "store_group_code": "4", "store_group_name": "abc123", - "store_name": "abc123", - "store_sort_order": 987, + "store_name": "xyz789", + "store_sort_order": 123, "timezone": "abc123", "title_separator": "xyz789", "use_store_in_url": true, "website_code": "4", "website_name": "xyz789", - "weight_unit": "abc123", - "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "xyz789", + "weight_unit": "xyz789", + "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_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "xyz789" + "zero_subtotal_title": "abc123" } ] } @@ -510,13 +510,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](#cart) +**Response:** [`Cart`](types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -604,13 +604,13 @@ query cart($cart_id: String!) { "custom_attributes": [CustomAttribute], "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, - "is_virtual": true, + "id": "4", + "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -630,15 +630,15 @@ This field is deprecated and will be removed. Return category views by IDs, with optional role filters and subtree scopes. In Adobe Commerce as a Cloud Service, this query replaces the `categories` query defined in the Commerce Foundation. -**Response:** [`[CategoryView]`](#categoryview) +**Response:** [`[CategoryView]`](types-c-e.md#categoryview) #### Arguments | Name | Description | |------|-------------| -| `ids` - [`[String!]`](#string) | List of category IDs to retrieve. For example, `123`, `456` or `789`. | -| `roles` - [`[String!]`](#string) | List of roles to filter the categories by. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | -| `subtree` - [`Subtree`](#subtree) | Subtree of the categories to retrieve. `startLevel` uses absolute category levels (root = 1). For example, `depth: 1`, `startLevel: 1`. | +| `ids` - [`[String!]`](types-q-s.md#string) | List of category IDs to retrieve. For example, `123`, `456` or `789`. | +| `roles` - [`[String!]`](types-q-s.md#string) | List of roles to filter the categories by. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `subtree` - [`Subtree`](types-q-s.md#subtree) | Subtree of the categories to retrieve. `startLevel` uses absolute category levels (root = 1). For example, `depth: 1`, `startLevel: 1`. | #### Example @@ -677,7 +677,7 @@ query categories( ```json { - "ids": ["xyz789"], + "ids": ["abc123"], "roles": ["xyz789"], "subtree": Subtree } @@ -691,17 +691,17 @@ query categories( "categories": [ { "availableSortBy": ["abc123"], - "children": ["abc123"], - "defaultSortBy": "xyz789", - "id": "4", + "children": ["xyz789"], + "defaultSortBy": "abc123", + "id": 4, "level": 987, - "name": "xyz789", - "parentId": "abc123", - "position": 123, + "name": "abc123", + "parentId": "xyz789", + "position": 987, "path": "abc123", "roles": ["xyz789"], "urlKey": "abc123", - "urlPath": "xyz789", + "urlPath": "abc123", "count": 987, "title": "abc123" } @@ -716,7 +716,7 @@ query categories( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) #### Example @@ -744,10 +744,10 @@ query checkoutAgreements { "checkoutAgreements": [ { "agreement_id": 123, - "checkbox_text": "xyz789", - "content": "xyz789", + "checkbox_text": "abc123", + "content": "abc123", "content_height": "abc123", - "is_html": true, + "is_html": false, "mode": "AUTO", "name": "xyz789" } @@ -762,7 +762,7 @@ query checkoutAgreements { Provide necessary information to build headless storefront when Adobe Commerce is connected to Commerce Optimizer. -**Response:** [`CommerceOptimizerContext!`](#commerceoptimizercontext) +**Response:** [`CommerceOptimizerContext!`](types-c-e.md#commerceoptimizercontext) #### Example @@ -794,7 +794,7 @@ query commerceOptimizer { Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](#company) +**Response:** [`Company`](types-c-e.md#company) #### Example @@ -877,8 +877,8 @@ query company { "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "custom_attributes": [CustomAttribute], - "email": "xyz789", - "id": 4, + "email": "abc123", + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "xyz789", "name": "xyz789", @@ -892,7 +892,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -904,13 +904,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](#comparelist) +**Response:** [`CompareList`](types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -946,7 +946,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -958,7 +958,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](#country) +**Response:** [`[Country]`](types-c-e.md#country) #### Example @@ -989,9 +989,9 @@ query countries { "available_regions": [Region], "full_name_english": "abc123", "full_name_locale": "abc123", - "id": "abc123", + "id": "xyz789", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } ] } @@ -1004,13 +1004,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](#country) +**Response:** [`Country`](types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](#string) | | +| `id` - [`String`](types-q-s.md#string) | | #### Example @@ -1047,8 +1047,8 @@ query country($id: String) { "full_name_english": "xyz789", "full_name_locale": "xyz789", "id": "abc123", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "abc123" } } } @@ -1060,7 +1060,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](#currency) +**Response:** [`Currency`](types-c-e.md#currency) #### Example @@ -1088,12 +1088,12 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "xyz789", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } } @@ -1106,13 +1106,13 @@ query currency { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | #### Example @@ -1156,7 +1156,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](#customer) +**Response:** [`Customer`](types-c-e.md#customer) #### Example @@ -1278,26 +1278,26 @@ 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", "default_billing": "abc123", - "default_shipping": "abc123", + "default_shipping": "xyz789", "email": "xyz789", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": 4, "is_subscribed": true, - "job_title": "abc123", - "lastname": "abc123", + "job_title": "xyz789", + "lastname": "xyz789", "middlename": "xyz789", "orders": CustomerOrders, "prefix": "xyz789", @@ -1334,7 +1334,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](#cart) +**Response:** [`Cart!`](types-c-e.md#cart) #### Example @@ -1418,7 +1418,7 @@ query customerCart { "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, @@ -1426,7 +1426,7 @@ query customerCart { "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1438,7 +1438,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) #### Example @@ -1472,7 +1472,7 @@ query customerDownloadableProducts { Provides Customer Group assigned to the Customer or Guest. -**Response:** [`CustomerGroupStorefront!`](#customergroupstorefront) +**Response:** [`CustomerGroupStorefront!`](types-c-e.md#customergroupstorefront) #### Example @@ -1498,7 +1498,7 @@ query customerGroup { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) #### Example @@ -1530,13 +1530,13 @@ query customerPaymentTokens { Customer segments associated with the current customer or guest/visitor. -**Response:** [`[CustomerSegmentStorefront]`](#customersegmentstorefront) +**Response:** [`[CustomerSegmentStorefront]`](types-c-e.md#customersegmentstorefront) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The unique ID of the cart to query. | +| `cartId` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -1559,11 +1559,7 @@ query customerSegments($cartId: String!) { ##### Response ```json -{ - "data": { - "customerSegments": [{"uid": "4"}] - } -} +{"data": {"customerSegments": [{"uid": 4}]}} ``` @@ -1572,13 +1568,13 @@ query customerSegments($cartId: String!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -1634,14 +1630,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | #### Example @@ -1681,10 +1677,10 @@ query getPaymentOrder( { "data": { "getPaymentOrder": { - "id": "abc123", + "id": "xyz789", "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -1696,13 +1692,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -1740,7 +1736,7 @@ query getPaymentSDK($location: PaymentLocation!) { Retrieves the vault configuration -**Response:** [`VaultConfigOutput`](#vaultconfigoutput) +**Response:** [`VaultConfigOutput`](types-t-z.md#vaultconfigoutput) #### Example @@ -1774,13 +1770,13 @@ query getVaultConfig { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](#giftcardaccount) +**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -1811,8 +1807,8 @@ query giftCardAccount($input: GiftCardAccountInput!) { "data": { "giftCardAccount": { "balance": Money, - "code": "xyz789", - "expiration_date": "abc123" + "code": "abc123", + "expiration_date": "xyz789" } } } @@ -1824,13 +1820,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](#giftregistry) +**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -1868,7 +1864,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -1877,20 +1873,20 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "abc123", + "created_at": "xyz789", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "xyz789", + "message": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } } } @@ -1902,13 +1898,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | #### Example @@ -1930,7 +1926,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -1941,11 +1937,11 @@ query giftRegistryEmailSearch($email: String!) { "giftRegistryEmailSearch": [ { "event_date": "xyz789", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": 4, - "location": "xyz789", + "location": "abc123", "name": "abc123", - "type": "xyz789" + "type": "abc123" } ] } @@ -1958,13 +1954,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -1996,12 +1992,12 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "data": { "giftRegistryIdSearch": [ { - "event_date": "abc123", - "event_title": "xyz789", + "event_date": "xyz789", + "event_title": "abc123", "gift_registry_uid": 4, - "location": "abc123", - "name": "abc123", - "type": "xyz789" + "location": "xyz789", + "name": "xyz789", + "type": "abc123" } ] } @@ -2014,15 +2010,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](#string) | The first name of the registrant. | -| `lastName` - [`String!`](#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](#id) | The type UID of the registry. | +| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2054,8 +2050,8 @@ query giftRegistryTypeSearch( ```json { "firstName": "xyz789", - "lastName": "abc123", - "giftRegistryTypeUid": 4 + "lastName": "xyz789", + "giftRegistryTypeUid": "4" } ``` @@ -2067,11 +2063,11 @@ query giftRegistryTypeSearch( "giftRegistryTypeSearch": [ { "event_date": "abc123", - "event_title": "xyz789", + "event_title": "abc123", "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", - "type": "xyz789" + "location": "xyz789", + "name": "abc123", + "type": "abc123" } ] } @@ -2084,7 +2080,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](#giftregistrytype) +**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) #### Example @@ -2112,7 +2108,7 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", + "label": "abc123", "uid": 4 } ] @@ -2126,13 +2122,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and billing last name. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderInformationInput!`](#guestorderinformationinput) | | +| `input` - [`GuestOrderInformationInput!`](types-f-i.md#guestorderinformationinput) | | #### Example @@ -2230,32 +2226,32 @@ query guestOrder($input: GuestOrderInformationInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "abc123", + "number": "xyz789", "order_date": "abc123", - "order_status_change_date": "xyz789", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", - "status": "abc123", - "token": "xyz789", + "shipping_method": "xyz789", + "status": "xyz789", + "token": "abc123", "total": OrderTotal } } @@ -2268,13 +2264,13 @@ query guestOrder($input: GuestOrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](#customerorder) +**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | #### Example @@ -2367,29 +2363,29 @@ query guestOrderByToken($input: OrderTokenInput!) { { "data": { "guestOrderByToken": { - "admin_assisted_order": 123, + "admin_assisted_order": 987, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", "invoices": [Invoice], - "is_virtual": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, "number": "xyz789", - "order_date": "abc123", - "order_status_change_date": "xyz789", + "order_date": "xyz789", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, @@ -2397,7 +2393,7 @@ query guestOrderByToken($input: OrderTokenInput!) { "shipping_address": OrderAddress, "shipping_method": "xyz789", "status": "abc123", - "token": "xyz789", + "token": "abc123", "total": OrderTotal } } @@ -2410,13 +2406,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2433,13 +2429,13 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} ``` @@ -2448,13 +2444,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2471,7 +2467,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2486,13 +2482,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](#string) | | +| `name` - [`String!`](types-q-s.md#string) | | #### Example @@ -2524,13 +2520,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | | +| `email` - [`String!`](types-q-s.md#string) | | #### Example @@ -2562,13 +2558,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address to check. | +| `email` - [`String!`](types-q-s.md#string) | The email address to check. | #### Example @@ -2585,13 +2581,13 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": false}}} +{"data": {"isEmailAvailable": {"is_email_available": true}}} ``` @@ -2600,13 +2596,13 @@ query isEmailAvailable($email: String!) { Check if logged-in customer is subscribed to price alert for a product. -**Response:** [`IsProductAlertSubscriptionResult!`](#isproductalertsubscriptionresult) +**Response:** [`IsProductAlertSubscriptionResult!`](types-f-i.md#isproductalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertPriceInput!`](#productalertpriceinput) | | +| `input` - [`ProductAlertPriceInput!`](types-k-p.md#productalertpriceinput) | | #### Example @@ -2633,7 +2629,7 @@ query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "isSubscribedProductAlertPrice": { - "isSubscribed": false, + "isSubscribed": true, "message": "xyz789" } } @@ -2646,13 +2642,13 @@ query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) { Check if logged-in customer is subscribed to stock alert for a product. -**Response:** [`IsProductAlertSubscriptionResult!`](#isproductalertsubscriptionresult) +**Response:** [`IsProductAlertSubscriptionResult!`](types-f-i.md#isproductalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertStockInput!`](#productalertstockinput) | | +| `input` - [`ProductAlertStockInput!`](types-k-p.md#productalertstockinput) | | #### Example @@ -2692,13 +2688,13 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](#negotiablequote) +**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](#id) | | +| `uid` - [`ID!`](types-f-i.md#id) | | #### Example @@ -2759,7 +2755,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -2774,27 +2770,27 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [CustomAttribute], "email": "abc123", "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "order": CustomerOrder, "prices": CartPrices, - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "SUBMITTED", "template_id": "4", - "template_name": "abc123", - "total_quantity": 987.65, + "template_name": "xyz789", + "total_quantity": 123.45, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -2806,13 +2802,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](#id) | | +| `templateId` - [`ID!`](types-f-i.md#id) | | #### Example @@ -2868,7 +2864,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": "4"} +{"templateId": 4} ``` ##### Response @@ -2879,16 +2875,16 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "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_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -2899,10 +2895,10 @@ query negotiableQuoteTemplate($templateId: ID!) { NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", + "template_id": 4, "total_quantity": 987.65, - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } } } @@ -2914,16 +2910,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -2976,7 +2972,7 @@ query negotiableQuoteTemplates( "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -2988,16 +2984,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3062,18 +3058,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](#pickuplocations) +**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3128,7 +3124,7 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -3140,18 +3136,18 @@ query pickupLocations( Search products using Live Search -**Response:** [`ProductSearchResponse!`](#productsearchresponse) +**Response:** [`ProductSearchResponse!`](types-k-p.md#productsearchresponse) #### Arguments | Name | Description | |------|-------------| -| `context` - [`QueryContextInput`](#querycontextinput) | The query context | -| `current_page` - [`Int`](#int) | Specifies which page of results to return. The default value is 1 Default: `1` | -| `filter` - [`[SearchClauseInput!]`](#searchclauseinput) | Identifies product attributes and conditions to filter on | -| `page_size` - [`Int`](#int) | The maximum number of results to return at once Default: `20` | -| `phrase` - [`String!`](#string) | Phrase to search for in product catalog | -| `sort` - [`[ProductSearchSortInput!]`](#productsearchsortinput) | Attributes and direction to sort on | +| `context` - [`QueryContextInput`](types-q-s.md#querycontextinput) | The query context | +| `current_page` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1 Default: `1` | +| `filter` - [`[SearchClauseInput!]`](types-q-s.md#searchclauseinput) | Identifies product attributes and conditions to filter on | +| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once Default: `20` | +| `phrase` - [`String!`](types-q-s.md#string) | Phrase to search for in product catalog | +| `sort` - [`[ProductSearchSortInput!]`](types-k-p.md#productsearchsortinput) | Attributes and direction to sort on | #### Example @@ -3201,7 +3197,7 @@ query productSearch( "current_page": 1, "filter": [SearchClauseInput], "page_size": 20, - "phrase": "abc123", + "phrase": "xyz789", "sort": [ProductSearchSortInput] } ``` @@ -3216,8 +3212,8 @@ query productSearch( "items": [ProductSearchItem], "page_info": SearchResultPageInfo, "related_terms": ["abc123"], - "suggestions": ["xyz789"], - "total_count": 987, + "suggestions": ["abc123"], + "total_count": 123, "warnings": [ProductSearchWarning] } } @@ -3230,13 +3226,13 @@ query productSearch( Search for products that match the specified SKU values. In Adobe Commerce as a Cloud Service, this query replaces the `products` query defined in the Commerce Foundation. -**Response:** [`[ProductView]`](#productview) +**Response:** [`[ProductView]`](types-k-p.md#productview) #### Arguments | Name | Description | |------|-------------| -| `skus` - [`[String]`](#string) | List of SKUs to search for. For example, `123`, `456` or `789`. | +| `skus` - [`[String]`](types-q-s.md#string) | List of SKUs to search for. For example, `123`, `456` or `789`. | #### Example @@ -3284,7 +3280,7 @@ query products($skus: [String]) { ##### Variables ```json -{"skus": ["abc123"]} +{"skus": ["xyz789"]} ``` ##### Response @@ -3296,26 +3292,26 @@ query products($skus: [String]) { { "addToCartAllowed": true, "inStock": true, - "lowStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], "description": "xyz789", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "abc123", + "metaDescription": "abc123", + "metaKeyword": "xyz789", "metaTitle": "xyz789", - "name": "xyz789", + "name": "abc123", "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], - "sku": "xyz789", + "sku": "abc123", "externalId": "xyz789", - "url": "abc123", + "url": "xyz789", "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "abc123", - "visibility": "abc123" + "queryType": "xyz789", + "visibility": "xyz789" } ] } @@ -3326,13 +3322,13 @@ query products($skus: [String]) { ### recaptchaFormConfig -**Response:** [`ReCaptchaConfigOutput`](#recaptchaconfigoutput) +**Response:** [`ReCaptchaConfigOutput`](types-q-s.md#recaptchaconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `formType` - [`ReCaptchaFormEnum!`](#recaptchaformenum) | | +| `formType` - [`ReCaptchaFormEnum!`](types-q-s.md#recaptchaformenum) | | #### Example @@ -3362,7 +3358,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": true + "is_enabled": false } } } @@ -3374,13 +3370,13 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { Returns reCAPTCHA configuration details for multiple form types in a single request. -**Response:** [`[ReCaptchaFormConfigItem]`](#recaptchaformconfigitem) +**Response:** [`[ReCaptchaFormConfigItem]`](types-q-s.md#recaptchaformconfigitem) #### Arguments | Name | Description | |------|-------------| -| `formTypes` - [`[ReCaptchaFormEnum!]!`](#recaptchaformenum) | | +| `formTypes` - [`[ReCaptchaFormEnum!]!`](types-q-s.md#recaptchaformenum) | | #### Example @@ -3413,7 +3409,7 @@ query recaptchaFormConfigs($formTypes: [ReCaptchaFormEnum!]!) { { "configurations": ReCaptchaConfiguration, "form_type": "PLACE_ORDER", - "is_enabled": false + "is_enabled": true } ] } @@ -3426,7 +3422,7 @@ query recaptchaFormConfigs($formTypes: [ReCaptchaFormEnum!]!) { Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3456,11 +3452,11 @@ query recaptchaV3Config { "badge_position": "xyz789", "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "abc123", - "minimum_score": 987.65, - "theme": "abc123", - "website_key": "xyz789" + "is_enabled": true, + "language_code": "xyz789", + "minimum_score": 123.45, + "theme": "xyz789", + "website_key": "abc123" } } } @@ -3472,20 +3468,20 @@ query recaptchaV3Config { Get Recommendations -**Response:** [`Recommendations`](#recommendations) +**Response:** [`Recommendations`](types-q-s.md#recommendations) #### Arguments | Name | Description | |------|-------------| -| `cartSkus` - [`[String]`](#string) | SKUs of products in the cart | -| `category` - [`String`](#string) | Category currently being viewed | -| `currentSku` - [`String`](#string) | SKU of the product currently being viewed on PDP | -| `currentProduct` - [`CurrentProductInput`](#currentproductinput) | Current product context from PDP (SKU, price, category, etc.) | -| `pageType` - [`PageType`](#pagetype) | Type of page on which recommendations are requested | -| `userPurchaseHistory` - [`[PurchaseHistory]`](#purchasehistory) | User purchase history with timestamp | -| `userViewHistory` - [`[ViewHistory]`](#viewhistory) | User view history with timestamp | -| `config` - [`UnitConfigInput`](#unitconfiginput) | Optional unit configuration | +| `cartSkus` - [`[String]`](types-q-s.md#string) | SKUs of products in the cart | +| `category` - [`String`](types-q-s.md#string) | Category currently being viewed | +| `currentSku` - [`String`](types-q-s.md#string) | SKU of the product currently being viewed on PDP | +| `currentProduct` - [`CurrentProductInput`](types-c-e.md#currentproductinput) | Current product context from PDP (SKU, price, category, etc.) | +| `pageType` - [`PageType`](types-k-p.md#pagetype) | Type of page on which recommendations are requested | +| `userPurchaseHistory` - [`[PurchaseHistory]`](types-k-p.md#purchasehistory) | User purchase history with timestamp | +| `userViewHistory` - [`[ViewHistory]`](types-t-z.md#viewhistory) | User view history with timestamp | +| `config` - [`UnitConfigInput`](types-t-z.md#unitconfiginput) | Optional unit configuration | #### Example @@ -3554,14 +3550,14 @@ query recommendations( Narrow down the results of a `products` query that was run against a complex product. Specify option IDs and SKUs to refine the product. -**Response:** [`ProductView`](#productview) +**Response:** [`ProductView`](types-k-p.md#productview) #### Arguments | Name | Description | |------|-------------| -| `optionIds` - [`[String!]!`](#string) | List of option IDs to refine the product by. For example, `123`, `456` or `789`. | -| `sku` - [`String!`](#string) | SKU of the product to refine. For example, `RF903`, `DG90-54` or `789-001`. | +| `optionIds` - [`[String!]!`](types-q-s.md#string) | List of option IDs to refine the product by. For example, `123`, `456` or `789`. | +| `sku` - [`String!`](types-q-s.md#string) | SKU of the product to refine. For example, `RF903`, `DG90-54` or `789-001`. | #### Example @@ -3616,7 +3612,7 @@ query refineProduct( ```json { - "optionIds": ["xyz789"], + "optionIds": ["abc123"], "sku": "abc123" } ``` @@ -3629,25 +3625,25 @@ query refineProduct( "refineProduct": { "addToCartAllowed": false, "inStock": false, - "lowStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], - "description": "abc123", - "id": 4, + "description": "xyz789", + "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", + "metaDescription": "abc123", + "metaKeyword": "abc123", "metaTitle": "abc123", "name": "abc123", - "shortDescription": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], "sku": "xyz789", - "externalId": "abc123", - "url": "xyz789", - "urlKey": "xyz789", + "externalId": "xyz789", + "url": "abc123", + "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "abc123", + "queryType": "xyz789", "visibility": "abc123" } } @@ -3660,13 +3656,13 @@ query refineProduct( View a shared requisition list when the receiver is logged in and belongs to the same company as the sender. -**Response:** [`SharedRequisitionListOutput`](#sharedrequisitionlistoutput) +**Response:** [`SharedRequisitionListOutput`](types-q-s.md#sharedrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `token` - [`String!`](#string) | The share token which is extracted from the requisition list share link and acts as an identifier for the requisition list. | +| `token` - [`String!`](types-q-s.md#string) | The share token which is extracted from the requisition list share link and acts as an identifier for the requisition list. | #### Example @@ -3686,7 +3682,7 @@ query sharedRequisitionList($token: String!) { ##### Variables ```json -{"token": "abc123"} +{"token": "xyz789"} ``` ##### Response @@ -3708,7 +3704,7 @@ query sharedRequisitionList($token: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](#storeconfig) +**Response:** [`StoreConfig`](types-q-s.md#storeconfig) #### Example @@ -3878,31 +3874,31 @@ query storeConfig { "data": { "storeConfig": { "allow_company_registration": true, - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "xyz789", "allow_items": "xyz789", "allow_order": "xyz789", "allow_printed_card": "xyz789", "autocomplete_on_storefront": false, - "base_currency_code": "xyz789", + "base_currency_code": "abc123", "base_link_url": "abc123", "base_media_url": "abc123", - "base_static_url": "abc123", - "base_url": "xyz789", - "cart_expires_in_days": 987, - "cart_gift_wrapping": "xyz789", + "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": 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": true, + "category_url_suffix": "abc123", + "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": "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", @@ -3912,116 +3908,116 @@ query storeConfig { "company_enabled": false, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, + "contact_enabled": false, "countries_with_required_region": "abc123", "create_account_confirmation": false, "customer_access_token_lifetime": 123.45, - "default_country": "xyz789", - "default_display_currency_code": "abc123", - "display_product_prices_in_catalog": 123, - "display_shipping_prices": 123, - "display_state_if_optional": true, - "enable_multiple_wishlists": "abc123", - "fixed_product_taxes_apply_tax_to_fpt": false, - "fixed_product_taxes_display_prices_in_emails": 123, - "fixed_product_taxes_display_prices_in_product_lists": 987, + "default_country": "abc123", + "default_display_currency_code": "xyz789", + "display_product_prices_in_catalog": 987, + "display_shipping_prices": 987, + "display_state_if_optional": false, + "enable_multiple_wishlists": "xyz789", + "fixed_product_taxes_apply_tax_to_fpt": true, + "fixed_product_taxes_display_prices_in_emails": 987, + "fixed_product_taxes_display_prices_in_product_lists": 123, "fixed_product_taxes_display_prices_in_sales_modules": 987, "fixed_product_taxes_display_prices_on_product_view_page": 123, - "fixed_product_taxes_enable": false, - "fixed_product_taxes_include_fpt_in_subtotal": false, - "graphql_share_customer_group": true, + "fixed_product_taxes_enable": true, + "fixed_product_taxes_include_fpt_in_subtotal": true, + "graphql_share_customer_group": false, "grid_per_page": 987, - "grid_per_page_values": "xyz789", + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": true, + "is_checkout_agreements_enabled": false, "is_default_store": true, "is_default_store_group": false, "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": true, + "is_negotiable_quote_active": false, "is_one_page_checkout_enabled": false, - "is_requisition_list_active": "abc123", - "list_mode": "abc123", + "is_requisition_list_active": "xyz789", + "list_mode": "xyz789", "list_per_page": 987, "list_per_page_values": "xyz789", - "locale": "xyz789", + "locale": "abc123", "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "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": "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": "abc123", "magento_reward_points_invitation_order_limit": "abc123", "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "xyz789", + "magento_reward_points_register": "abc123", "magento_reward_points_review": "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, - "minicart_max_items": 987, + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, + "minicart_max_items": 123, "minimum_password_length": "abc123", - "newsletter_enabled": true, + "newsletter_enabled": false, "optional_zip_countries": "xyz789", - "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_price": 123, + "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": 123, - "orders_invoices_credit_memos_display_subtotal": 123, - "orders_invoices_credit_memos_display_zero_tax": true, + "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_message": "xyz789", + "quote_minimum_amount": 987.65, + "quote_minimum_amount_message": "abc123", "required_character_classes_number": "abc123", "requisition_list_share_link_validity_days": 987, - "requisition_list_share_max_recipients": 987, - "requisition_list_share_storefront_path": "xyz789", - "requisition_list_sharing_enabled": true, + "requisition_list_share_max_recipients": 123, + "requisition_list_share_storefront_path": "abc123", + "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", "secure_base_link_url": "abc123", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "abc123", - "secure_base_url": "abc123", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "xyz789", "share_active_segments": false, - "share_applied_cart_rule": false, + "share_applied_cart_rule": true, "shopping_assistance_checkbox_title": "xyz789", - "shopping_assistance_checkbox_tooltip": "abc123", - "shopping_assistance_enabled": false, - "shopping_cart_display_full_summary": false, + "shopping_assistance_checkbox_tooltip": "xyz789", + "shopping_assistance_enabled": true, + "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": 987, + "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "store_code": 4, "store_group_code": 4, - "store_group_name": "xyz789", - "store_name": "xyz789", - "store_sort_order": 123, - "timezone": "xyz789", + "store_group_name": "abc123", + "store_name": "abc123", + "store_sort_order": 987, + "timezone": "abc123", "title_separator": "xyz789", "use_store_in_url": true, - "website_code": "4", - "website_name": "xyz789", + "website_code": 4, + "website_name": "abc123", "weight_unit": "abc123", "zero_subtotal_enable_for_specific_countries": true, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 123, + "zero_subtotal_new_order_status": "abc123", + "zero_subtotal_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "xyz789" } } @@ -4032,16 +4028,16 @@ query storeConfig { ### variants -**Response:** [`ProductViewVariantResults`](#productviewvariantresults) +**Response:** [`ProductViewVariantResults`](types-k-p.md#productviewvariantresults) #### Arguments | Name | Description | |------|-------------| -| `sku` - [`String!`](#string) | SKU of the product to get variants for. For example, `UR123`, `MZ456` or `KS789`. | -| `optionIds` - [`[String!]`](#string) | List of option IDs to get variants for. For example, `123`, `456` or `789`. | -| `pageSize` - [`Int`](#int) | Page size for pagination. For example, `10` for a page size of 10 or `20` for a page size of 20. | -| `cursor` - [`String`](#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | +| `sku` - [`String!`](types-q-s.md#string) | SKU of the product to get variants for. For example, `UR123`, `MZ456` or `KS789`. | +| `optionIds` - [`[String!]`](types-q-s.md#string) | List of option IDs to get variants for. For example, `123`, `456` or `789`. | +| `pageSize` - [`Int`](types-f-i.md#int) | Page size for pagination. For example, `10` for a page size of 10 or `20` for a page size of 20. | +| `cursor` - [`String`](types-q-s.md#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | #### Example @@ -4073,9 +4069,9 @@ query variants( ```json { "sku": "xyz789", - "optionIds": ["xyz789"], - "pageSize": 123, - "cursor": "abc123" + "optionIds": ["abc123"], + "pageSize": 987, + "cursor": "xyz789" } ``` 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 index b9901024b..26e3de536 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md @@ -8,7 +8,7 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -26,7 +26,7 @@ Contains details about the cart after adding custom attributes to it items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The custom attributes to cart item have been added. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The custom attributes to cart item have been added. | #### Example @@ -42,8 +42,8 @@ Contains details about the cart after adding custom attributes to it items. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example @@ -64,7 +64,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | #### Example @@ -82,10 +82,10 @@ Defines a new registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | #### Example @@ -95,8 +95,8 @@ Defines a new registrant. GiftRegistryDynamicAttributeInput ], "email": "xyz789", - "firstname": "xyz789", - "lastname": "abc123" + "firstname": "abc123", + "lastname": "xyz789" } ``` @@ -110,7 +110,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -128,8 +128,8 @@ Contains details about the cart after adding products to it. | 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. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | #### Example @@ -150,8 +150,8 @@ Contains products to add to an existing compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example @@ -169,8 +169,8 @@ Contains details about the cart after adding products to it. | 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. | +| `cart` - [`Cart`](types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -191,7 +191,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -209,8 +209,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -231,8 +231,8 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example @@ -253,7 +253,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -271,8 +271,8 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example @@ -280,8 +280,8 @@ Defines the purchase order and cart to act on. ```json { "cart_id": "xyz789", - "purchase_order_uid": "4", - "replace_existing_cart_items": true + "purchase_order_uid": 4, + "replace_existing_cart_items": false } ``` @@ -295,7 +295,7 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | +| `message` - [`String!`](types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example @@ -337,7 +337,7 @@ Output of the request to add items in a requisition list to the cart. | 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. | +| `cart` - [`Cart`](types-c-e.md#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 @@ -362,8 +362,8 @@ Defines a return comment. | 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. | +| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -384,7 +384,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `return` - [`Return`](types-q-s.md#return) | The modified return. | #### Example @@ -402,17 +402,17 @@ Defines tracking information to be added to the return. | 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. | +| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { "carrier_uid": 4, - "return_uid": 4, - "tracking_number": "abc123" + "return_uid": "4", + "tracking_number": "xyz789" } ``` @@ -426,8 +426,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -448,9 +448,9 @@ Contains the resultant wish list and any error information. | 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. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#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. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -459,7 +459,7 @@ Contains the resultant wish list and any error information. "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": true, + "status": false, "wishlist": Wishlist } ``` @@ -474,9 +474,9 @@ A single admin assistance action performed on behalf of the customer. | 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. | +| `action` - [`String!`](types-q-s.md#string) | Action identifier, e.g. add_to_cart, place_order. | +| `date` - [`String!`](types-q-s.md#string) | When the action occurred. | +| `details` - [`String`](types-q-s.md#string) | Action related details, e.g. product SKUs, order id. | #### Example @@ -499,8 +499,8 @@ Paginated admin assistance actions for the customer. | 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. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The total count of admin assistance actions for the customer. | #### Example @@ -522,9 +522,9 @@ A bucket that contains information for each filterable option | Field Name | Description | |------------|-------------| -| `attribute` - [`String!`](#string) | The attribute code of the filter item | +| `attribute` - [`String!`](types-q-s.md#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 | +| `title` - [`String!`](types-q-s.md#string) | The filter name displayed in layered navigation | | `type` - [`AggregationType`](#aggregationtype) | Identifies the data type of the aggregation | #### Example @@ -533,7 +533,7 @@ A bucket that contains information for each filterable option { "attribute": "abc123", "buckets": [Bucket], - "title": "xyz789", + "title": "abc123", "type": "INTELLIGENT" } ``` @@ -567,13 +567,13 @@ Identifies the data type of the aggregation | 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 | +| `code` - [`String`](types-q-s.md#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 | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -582,8 +582,8 @@ Identifies the data type of the aggregation "button_styles": ButtonStyles, "code": "xyz789", "is_visible": false, - "payment_intent": "abc123", - "payment_source": "abc123", + "payment_intent": "xyz789", + "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "abc123", "title": "xyz789" @@ -600,9 +600,9 @@ Apple Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example @@ -624,12 +624,12 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example ```json -{"code": "xyz789"} +{"code": "abc123"} ``` @@ -642,10 +642,10 @@ Contains an applied gift card with applied and remaining balance. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -654,7 +654,7 @@ Contains an applied gift card with applied and remaining balance. "applied_balance": Money, "code": "abc123", "current_balance": Money, - "expiration_date": "xyz789" + "expiration_date": "abc123" } ``` @@ -669,16 +669,16 @@ The rule that was applied to this product | 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 | +| `rule_id` - [`String`](types-q-s.md#string) | The ID assigned to the rule | +| `rule_name` - [`String`](types-q-s.md#string) | The name of the applied rule | #### Example ```json { "action_type": "BOOST", - "rule_id": "xyz789", - "rule_name": "xyz789" + "rule_id": "abc123", + "rule_name": "abc123" } ``` @@ -712,8 +712,8 @@ Contains the applied and current balances. | 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. | +| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](types-k-p.md#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 @@ -722,7 +722,7 @@ Contains the applied and current balances. { "applied_balance": Money, "current_balance": Money, - "enabled": false + "enabled": true } ``` @@ -736,15 +736,15 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | #### Example ```json { - "cart_id": "xyz789", - "coupon_code": "abc123" + "cart_id": "abc123", + "coupon_code": "xyz789" } ``` @@ -758,7 +758,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -795,8 +795,8 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](types-q-s.md#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 @@ -819,8 +819,8 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example @@ -841,7 +841,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -859,15 +859,15 @@ Contains applied gift cards with gift card code and amount. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](#string) | The gift card account code. | +| `applied_balance` - [`Money!`](types-k-p.md#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](types-q-s.md#string) | The gift card account code. | #### Example ```json { "applied_balance": Money, - "code": "xyz789" + "code": "abc123" } ``` @@ -881,7 +881,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -899,7 +899,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -917,7 +917,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -935,13 +935,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | 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. | +| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 123, "search_term": "xyz789"} +{"radius": 987, "search_term": "xyz789"} ``` @@ -954,20 +954,20 @@ Contains information about an asset image. | Field Name | Description | |------------|-------------| -| `asset_image` - [`ProductMediaGalleryEntriesAssetImage`](#productmediagalleryentriesassetimage) | Contains a `ProductMediaGalleryEntriesAssetImage` object. | +| `asset_image` - [`ProductMediaGalleryEntriesAssetImage`](types-k-p.md#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. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { "asset_image": ProductMediaGalleryEntriesAssetImage, - "disabled": true, + "disabled": false, "label": "abc123", - "position": 123, + "position": 987, "url": "abc123" } ``` @@ -982,11 +982,11 @@ Contains information about an asset video. | Field Name | Description | |------------|-------------| -| `asset_video` - [`ProductMediaGalleryEntriesAssetVideo`](#productmediagalleryentriesassetvideo) | Contains a `ProductMediaGalleryEntriesAssetVideo` object. | +| `asset_video` - [`ProductMediaGalleryEntriesAssetVideo`](types-k-p.md#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. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Example @@ -996,7 +996,7 @@ Contains information about an asset video. "disabled": false, "label": "abc123", "position": 987, - "url": "abc123" + "url": "xyz789" } ``` @@ -1010,13 +1010,16 @@ Defines the input schema for assigning a child company to a parent company. | 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. | +| `child_company_id` - [`ID!`](types-f-i.md#id) | The unique ID of the child company. | +| `parent_company_id` - [`ID!`](types-f-i.md#id) | The unique ID of the parent company. | #### Example ```json -{"child_company_id": 4, "parent_company_id": 4} +{ + "child_company_id": 4, + "parent_company_id": "4" +} ``` @@ -1029,7 +1032,7 @@ Contains the response to the request to assign a child company. | Field Name | Description | |------------|-------------| -| `company_hierarchy` - [`CompanyHierarchy!`](#companyhierarchy) | The updated company hierarchy for the parent company. | +| `company_hierarchy` - [`CompanyHierarchy!`](types-c-e.md#companyhierarchy) | The updated company hierarchy for the parent company. | #### Example @@ -1047,13 +1050,13 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](types-c-e.md#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} +{"compare_list": CompareList, "result": false} ``` @@ -1086,18 +1089,18 @@ List of all entity types. Populated by the modules introducing EAV entities. | 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. | +| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `url` - [`String!`](types-q-s.md#string) | File URL to download the file. | +| `value` - [`String!`](types-q-s.md#string) | File code. For file download use `url` field. | #### Example ```json { "attribute_type": "xyz789", - "code": "4", - "url": "abc123", + "code": 4, + "url": "xyz789", "value": "xyz789" } ``` @@ -1134,11 +1137,11 @@ An input object that specifies the filters used for attributes. "is_filterable_in_search": true, "is_html_allowed_on_front": false, "is_searchable": true, - "is_used_for_customer_segment": false, - "is_used_for_price_rules": true, - "is_used_for_promo_rules": false, + "is_used_for_customer_segment": true, + "is_used_for_price_rules": false, + "is_used_for_promo_rules": true, "is_visible_in_advanced_search": true, - "is_visible_on_front": false, + "is_visible_on_front": true, "is_wysiwyg_enabled": false, "used_in_product_listing": true } @@ -1185,18 +1188,18 @@ EAV attribute frontend input types. | 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. | +| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `url` - [`String!`](types-q-s.md#string) | Image URL to download the image. | +| `value` - [`String!`](types-q-s.md#string) | Image code. For image download use `url` field. | #### Example ```json { - "attribute_type": "xyz789", + "attribute_type": "abc123", "code": 4, - "url": "xyz789", + "url": "abc123", "value": "xyz789" } ``` @@ -1211,14 +1214,14 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "entity_type": "xyz789" } ``` @@ -1233,12 +1236,12 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1251,28 +1254,28 @@ Base EAV implementation of CustomAttributeMetadataInterface. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#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_class` - [`String`](types-q-s.md#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. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example ```json { - "code": "4", - "default_value": "xyz789", + "code": 4, + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_required": true, "is_unique": true, - "label": "xyz789", + "label": "abc123", "options": [CustomAttributeOptionInterface] } ``` @@ -1287,7 +1290,7 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example @@ -1330,8 +1333,8 @@ Contains the output of the `attributeMetadata` query | 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 | +| `filterableInSearch` - [`[FilterableInSearchAttribute!]`](types-f-i.md#filterableinsearchattribute) | An array of product attributes that can be used for filtering in a `productSearch` query | +| `sortable` - [`[SortableAttribute!]`](types-q-s.md#sortableattribute) | An array of product attributes that can be used for sorting in a `productSearch` query | #### Example @@ -1353,16 +1356,16 @@ Base EAV implementation of CustomAttributeOptionInterface. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Example ```json { "is_default": true, - "label": "xyz789", - "value": "abc123" + "label": "abc123", + "value": "xyz789" } ``` @@ -1374,15 +1377,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Example ```json { "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -1394,8 +1397,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1408,7 +1411,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1420,8 +1423,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | +| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example @@ -1442,15 +1445,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The attribute value. | #### Example ```json { - "attribute_type": "abc123", + "attribute_type": "xyz789", "code": "4", "value": "xyz789" } @@ -1466,15 +1469,15 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `attribute_code` - [`String!`](types-q-s.md#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. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "selected_options": [AttributeInputSelectedOption], "value": "xyz789" } @@ -1488,8 +1491,8 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | +| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1499,15 +1502,12 @@ Specifies the value for attribute. | [`AttributeImage`](#attributeimage) | | [`AttributeSelectedOptions`](#attributeselectedoptions) | | [`AttributeValue`](#attributevalue) | -| [`ProductAttributeFile`](#productattributefile) | +| [`ProductAttributeFile`](types-k-p.md#productattributefile) | #### Example ```json -{ - "attribute_type": "xyz789", - "code": "4" -} +{"attribute_type": "xyz789", "code": 4} ``` @@ -1521,7 +1521,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1543,7 +1543,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1562,7 +1562,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| -| `liability_shift` - [`LiabilityShift`](#liabilityshift) | Liability Shift | +| `liability_shift` - [`LiabilityShift`](types-k-p.md#liabilityshift) | Liability Shift | #### Example @@ -1580,13 +1580,13 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | #### Example ```json -{"code": "AFN", "symbol": "xyz789"} +{"code": "AFN", "symbol": "abc123"} ``` @@ -1599,16 +1599,16 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | +| `code` - [`String!`](types-q-s.md#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. | +| `oope_payment_method_config` - [`OopePaymentMethodConfig`](types-k-p.md#oopepaymentmethodconfig) | Configuration for out of process payment methods | +| `title` - [`String!`](types-q-s.md#string) | The payment method title. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "is_deferred": true, "oope_payment_method_config": OopePaymentMethodConfig, "title": "abc123" @@ -1625,16 +1625,16 @@ Contains details about the possible shipping methods and carriers. | 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. | +| `additional_data` - [`[ShippingAdditionalData]`](types-q-s.md#shippingadditionaldata) | Additional data related to the shipping method. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1642,12 +1642,12 @@ Contains details about the possible shipping methods and carriers. { "additional_data": [ShippingAdditionalData], "amount": Money, - "available": false, - "carrier_code": "xyz789", + "available": true, + "carrier_code": "abc123", "carrier_title": "abc123", - "error_message": "xyz789", - "method_code": "xyz789", - "method_title": "xyz789", + "error_message": "abc123", + "method_code": "abc123", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1681,9 +1681,9 @@ Defines the billing address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `customer_address_uid` - [`ID`](types-f-i.md#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. | @@ -1692,10 +1692,10 @@ Defines the billing address. ```json { "address": CartAddressInput, - "customer_address_id": 987, - "customer_address_uid": "4", + "customer_address_id": 123, + "customer_address_uid": 4, "same_as_shipping": true, - "use_for_shipping": false + "use_for_shipping": true } ``` @@ -1709,12 +1709,12 @@ The billing address information | 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 | +| `address_line_1` - [`String`](types-q-s.md#string) | The first line of the address | +| `address_line_2` - [`String`](types-q-s.md#string) | The second line of the address | +| `city` - [`String`](types-q-s.md#string) | The city of the address | +| `country_code` - [`String!`](types-q-s.md#string) | The country of the address | +| `postal_code` - [`String`](types-q-s.md#string) | The postal code of the address | +| `region` - [`String`](types-q-s.md#string) | The region of the address | #### Example @@ -1724,8 +1724,8 @@ The billing address information "address_line_2": "xyz789", "city": "abc123", "country_code": "xyz789", - "postal_code": "xyz789", - "region": "xyz789" + "postal_code": "abc123", + "region": "abc123" } ``` @@ -1739,43 +1739,43 @@ Contains details about the billing address. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](types-c-e.md#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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", + "customer_address_uid": "4", + "fax": "abc123", "firstname": "abc123", "id": 123, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CartAddressRegion, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "xyz789", "telephone": "xyz789", "uid": "4", @@ -1789,6 +1789,12 @@ Contains details about the billing address. The `Boolean` scalar type represents `true` or `false`. +#### Example + +```json +true +``` + ### Breadcrumb @@ -1799,19 +1805,19 @@ Contains details about an individual category that comprises a breadcrumb. | 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. | +| `category_level` - [`Int`](types-f-i.md#int) | The category level. | +| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | #### Example ```json { - "category_level": 123, - "category_name": "xyz789", - "category_uid": "4", + "category_level": 987, + "category_name": "abc123", + "category_uid": 4, "category_url_key": "xyz789", "category_url_path": "abc123" } @@ -1827,22 +1833,22 @@ An interface for bucket contents | Field Name | Description | |------------|-------------| -| `title` - [`String!`](#string) | A human-readable name of a bucket | +| `title` - [`String!`](types-q-s.md#string) | A human-readable name of a bucket | #### Possible Types | Bucket Types | |----------------| -| [`CategoryBucket`](#categorybucket) | -| [`CategoryView`](#categoryview) | -| [`RangeBucket`](#rangebucket) | -| [`ScalarBucket`](#scalarbucket) | -| [`StatsBucket`](#statsbucket) | +| [`CategoryBucket`](types-c-e.md#categorybucket) | +| [`CategoryView`](types-c-e.md#categoryview) | +| [`RangeBucket`](types-q-s.md#rangebucket) | +| [`ScalarBucket`](types-q-s.md#scalarbucket) | +| [`StatsBucket`](types-q-s.md#statsbucket) | #### Example ```json -{"title": "abc123"} +{"title": "xyz789"} ``` @@ -1855,33 +1861,33 @@ An implementation for bundle product cart items. | 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. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#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. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", + "backorder_message": "abc123", "bundle_options": [SelectedBundleOption], "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], @@ -1890,15 +1896,15 @@ An implementation for bundle product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": false, - "is_salable": true, - "max_qty": 987.65, - "min_qty": 123.45, + "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": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -1913,15 +1919,15 @@ Defines bundle product options for `CreditMemoItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -1930,12 +1936,12 @@ Defines bundle product options for `CreditMemoItemInterface`. "bundle_options": [ItemSelectedBundleOption], "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } ``` @@ -1949,15 +1955,15 @@ Defines bundle product options for `InvoiceItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1970,7 +1976,7 @@ Defines bundle product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 987.65 } ``` @@ -1986,23 +1992,23 @@ Defines an individual item within a bundle product. | 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 | +| `position` - [`Int`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](types-k-p.md#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. | +| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example ```json { "options": [BundleItemOption], - "position": 987, + "position": 123, "price_range": PriceRange, "required": true, - "sku": "abc123", + "sku": "xyz789", "title": "xyz789", "type": "xyz789", "uid": 4 @@ -2021,27 +2027,27 @@ Defines the characteristics that comprise a specific bundle item and its options |------------|-------------| | `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. | +| `label` - [`String`](types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": true, - "is_default": false, - "label": "abc123", - "position": 123, - "price": 123.45, + "can_change_quantity": false, + "is_default": true, + "label": "xyz789", + "position": 987, + "price": 987.65, "price_type": "FIXED", "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -2055,31 +2061,31 @@ Defines bundle product options for `OrderItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -2093,23 +2099,23 @@ Defines bundle product options for `OrderItemInterface`. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "abc123", + "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 123.45, + "product_url_key": "xyz789", + "quantity_canceled": 987.65, "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, "quantity_return_requested": 123.45, - "quantity_returned": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -2123,54 +2129,54 @@ Defines basic features of a bundle product and contains multiple BundleItems. | 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. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#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. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2178,47 +2184,47 @@ Defines basic features of a bundle product and contains multiple BundleItems. { "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "dynamic_price": false, + "dynamic_price": true, "dynamic_sku": false, "dynamic_weight": true, "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "items": [BundleItem], "manufacturer": 987, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "min_sale_qty": 987.65, "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_details": PriceDetails, "price_range": PriceRange, "price_tiers": [TierPrice], "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "related_products": [ProductInterface], "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 123.45, "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], @@ -2237,12 +2243,12 @@ Contains details about bundle products added to a requisition list. | 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. | +| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2251,9 +2257,9 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "sku": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -2267,13 +2273,13 @@ Defines bundle product options for `ShipmentItemInterface`. | 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. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example @@ -2285,7 +2291,7 @@ Defines bundle product options for `ShipmentItemInterface`. "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 987.65 + "quantity_shipped": 123.45 } ``` @@ -2299,13 +2305,13 @@ Defines bundle product options for `WishlistItemInterface`. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -2314,8 +2320,8 @@ Defines bundle product options for `WishlistItemInterface`. "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -2329,11 +2335,11 @@ Defines bundle product options for `WishlistItemInterface`. | 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 | +| `color` - [`String`](types-q-s.md#string) | The button color | +| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](types-q-s.md#string) | The button label | +| `layout` - [`String`](types-q-s.md#string) | The button layout | +| `shape` - [`String`](types-q-s.md#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 | @@ -2341,13 +2347,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "xyz789", + "color": "abc123", "height": 123, - "label": "xyz789", + "label": "abc123", "layout": "xyz789", "shape": "xyz789", - "tagline": false, - "use_default_height": false + "tagline": true, + "use_default_height": true } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md index dc8677146..8a6d798a5 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md @@ -8,14 +8,14 @@ Specifies the quote template id of the quote template to cancel | 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. | +| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "cancellation_comment": "abc123", + "cancellation_comment": "xyz789", "template_id": "4" } ``` @@ -29,14 +29,14 @@ Specifies the quote template id of the quote template to cancel | Field Name | Description | |------------|-------------| | `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" + "message": "xyz789" } ``` @@ -71,8 +71,8 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](#string) | Cancellation reason. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | #### Example @@ -90,7 +90,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | | `errorV2` - [`CancelOrderError`](#cancelordererror) | | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | @@ -112,12 +112,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](#string) | | +| `description` - [`String!`](types-q-s.md#string) | | #### Example ```json -{"description": "xyz789"} +{"description": "abc123"} ``` @@ -128,12 +128,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `authentication_result` - [`AuthenticationResult`](#authenticationresult) | Authentication result | +| `authentication_result` - [`AuthenticationResult`](types-a-b.md#authenticationresult) | Authentication result | | `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 | +| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](types-q-s.md#string) | Name on the card | #### Example @@ -143,7 +143,7 @@ Contains the updated customer order and error message if any. "bin_details": CardBin, "card_expiry_month": "xyz789", "card_expiry_year": "abc123", - "last_digits": "abc123", + "last_digits": "xyz789", "name": "xyz789" } ``` @@ -156,12 +156,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `bin` - [`String`](types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "xyz789"} +{"bin": "abc123"} ``` @@ -174,8 +174,8 @@ The card payment source information | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](#string) | The name on the cardholder | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](types-q-s.md#string) | The name on the cardholder | #### Example @@ -196,15 +196,15 @@ The card payment source information | 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 | +| `brand` - [`String`](types-q-s.md#string) | The brand of the card | +| `expiry` - [`String`](types-q-s.md#string) | The expiry of the card | +| `last_digits` - [`String`](types-q-s.md#string) | The last digits of the card | #### Example ```json { - "brand": "abc123", + "brand": "xyz789", "expiry": "xyz789", "last_digits": "xyz789" } @@ -220,27 +220,27 @@ Contains the contents and other details about a guest or customer cart. | 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. | +| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](types-a-b.md#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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](types-a-b.md#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. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#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. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -258,7 +258,7 @@ Contains the contents and other details about a guest or customer cart. "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, @@ -266,7 +266,7 @@ Contains the contents and other details about a guest or customer cart. "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } ``` @@ -280,14 +280,14 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `code` - [`String!`](types-q-s.md#string) | The country code. | +| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "abc123" } ``` @@ -302,45 +302,45 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "xyz789", "custom_attributes": [AttributeValueInput], "fax": "abc123", "firstname": "xyz789", "lastname": "abc123", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": "xyz789", - "region_id": 123, - "save_in_address_book": false, - "street": ["xyz789"], + "region_id": 987, + "save_in_address_book": true, + "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -352,54 +352,54 @@ Defines the billing or shipping address to be applied to the cart. | 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. | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`BillingCartAddress`](#billingcartaddress) | -| [`ShippingCartAddress`](#shippingcartaddress) | +| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | +| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | #### Example ```json { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", + "customer_address_uid": 4, "fax": "xyz789", "firstname": "abc123", "id": 987, "lastname": "abc123", "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CartAddressRegion, "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "uid": 4, - "vat_id": "abc123" + "suffix": "xyz789", + "telephone": "xyz789", + "uid": "4", + "vat_id": "xyz789" } ``` @@ -413,16 +413,16 @@ Contains details about the region in a billing or shipping address. | 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`](types-q-s.md#string) | The state or province code. | +| `label` - [`String`](types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "abc123", - "label": "xyz789", + "code": "xyz789", + "label": "abc123", "region_id": 987 } ``` @@ -437,14 +437,14 @@ Defines a cart custom attributes. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The cart ID. | +| `cart_id` - [`String!`](types-q-s.md#string) | The cart ID. | | `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "custom_attributes": [CustomAttributeInput] } ``` @@ -476,16 +476,16 @@ Defines a cart item custom attributes. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The cart ID. | -| `cart_item_id` - [`String!`](#string) | The cart item ID. | +| `cart_id` - [`String!`](types-q-s.md#string) | The cart ID. | +| `cart_item_id` - [`String!`](types-q-s.md#string) | The cart item ID. | | `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart item. | #### Example ```json { - "cart_id": "abc123", - "cart_item_id": "xyz789", + "cart_id": "xyz789", + "cart_item_id": "abc123", "custom_attributes": [CustomAttributeInput] } ``` @@ -499,12 +499,12 @@ Defines a cart item custom attributes. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `message` - [`String!`](types-q-s.md#string) | A localized error message | #### Example ```json -{"code": "UNDEFINED", "message": "xyz789"} +{"code": "UNDEFINED", "message": "abc123"} ``` @@ -536,10 +536,10 @@ Defines an item to be added to the cart. | 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. | +| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | #### Example @@ -547,9 +547,9 @@ Defines an item to be added to the cart. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 987.65, + "quantity": 123.45, "selected_options": ["4"], - "sku": "xyz789" + "sku": "abc123" } ``` @@ -563,32 +563,32 @@ An interface for products in a cart. | Field Name | Description | |------------|-------------| -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `backorder_message` - [`String`](types-q-s.md#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. | +| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`BundleCartItem`](#bundlecartitem) | +| [`BundleCartItem`](types-a-b.md#bundlecartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | +| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | +| [`SimpleCartItem`](types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | #### Example @@ -600,15 +600,15 @@ An interface for products in a cart. "errors": [CartItemError], "is_available": false, "is_salable": false, - "max_qty": 987.65, - "min_qty": 987.65, - "not_available_message": "abc123", + "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" + "quantity": 987.65, + "uid": 4 } ``` @@ -622,17 +622,17 @@ Contains details about the price of the item, including taxes and discounts. | 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. | +| `catalog_discount` - [`ProductDiscount`](types-k-p.md#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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](types-k-p.md#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -662,9 +662,9 @@ Contains details about the price of a selected customizable value. | 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. | +| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](types-f-i.md#float) | A price value. | #### Example @@ -686,17 +686,17 @@ A single item to be updated. | Input Field | Description | |-------------|-------------| -| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `cart_item_uid` - [`ID`](types-f-i.md#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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | #### Example ```json { - "cart_item_uid": "4", + "cart_item_uid": 4, "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": "4", @@ -713,8 +713,8 @@ A single item to be updated. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | #### Example @@ -737,14 +737,14 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| | `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | -| `custom_fees` - [`[OopeCustomFee]`](#oopecustomfee) | Custom fees applied to the cart via out-of-process webhooks. | +| `custom_fees` - [`[OopeCustomFee]`](types-k-p.md#oopecustomfee) | Custom fees applied to the cart via out-of-process webhooks. | | `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. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -770,12 +770,12 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CartRule` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartRule` object. | #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -788,15 +788,15 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | #### Example ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -809,7 +809,7 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -876,58 +876,58 @@ Swatch attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](types-q-s.md#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. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example ```json { "apply_to": ["SIMPLE"], - "code": "4", + "code": 4, "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_comparable": false, - "is_filterable": true, + "is_comparable": true, + "is_filterable": false, "is_filterable_in_search": true, "is_html_allowed_on_front": false, "is_required": false, "is_searchable": true, "is_unique": false, - "is_used_for_price_rules": true, - "is_used_for_promo_rules": true, - "is_visible_in_advanced_search": true, + "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, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", - "update_product_preview_image": true, - "use_product_image_for_swatch": true, - "used_in_product_listing": false + "update_product_preview_image": false, + "use_product_image_for_swatch": false, + "used_in_product_listing": true } ``` @@ -941,10 +941,10 @@ New category bucket for federation | Field Name | Description | |------------|-------------| -| `count` - [`Int!`](#int) | | -| `id` - [`ID!`](#id) | | -| `path` - [`String!`](#string) | | -| `title` - [`String!`](#string) | | +| `count` - [`Int!`](types-f-i.md#int) | | +| `id` - [`ID!`](types-f-i.md#id) | | +| `path` - [`String!`](types-q-s.md#string) | | +| `title` - [`String!`](types-q-s.md#string) | | #### Example @@ -953,7 +953,7 @@ New category bucket for federation "count": 987, "id": 4, "path": "abc123", - "title": "abc123" + "title": "xyz789" } ``` @@ -965,7 +965,7 @@ New category bucket for federation | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | | +| `id` - [`ID!`](types-f-i.md#id) | | #### Possible Types @@ -976,7 +976,7 @@ New category bucket for federation #### Example ```json -{"id": "4"} +{"id": 4} ``` @@ -989,31 +989,31 @@ Contains the full set of attributes that can be returned in a category search. | 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. | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | #### Possible Types @@ -1025,30 +1025,30 @@ Contains the full set of attributes that can be returned in a category search. ```json { - "available_sort_by": ["abc123"], + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children_count": "xyz789", - "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", + "custom_layout_update_file": "xyz789", + "default_sort_by": "abc123", "description": "abc123", - "display_mode": "xyz789", - "filter_price_range": 123.45, - "image": "abc123", - "include_in_menu": 123, + "display_mode": "abc123", + "filter_price_range": 987.65, + "image": "xyz789", + "include_in_menu": 987, "is_anchor": 123, - "landing_page": 123, - "level": 987, + "landing_page": 987, + "level": 123, "meta_description": "xyz789", "meta_keywords": "abc123", "meta_title": "abc123", - "name": "xyz789", + "name": "abc123", "path": "xyz789", "path_in_store": "abc123", "position": 987, "product_count": 987, "uid": 4, - "url_key": "xyz789", + "url_key": "abc123", "url_path": "abc123" } ``` @@ -1063,59 +1063,59 @@ Contains the hierarchy of categories. | 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. | +| `available_sort_by` - [`[String]`](types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | +| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | +| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](types-q-s.md#string) | | +| `filter_price_range` - [`Float`](types-f-i.md#float) | | +| `image` - [`String`](types-q-s.md#string) | | +| `include_in_menu` - [`Int`](types-f-i.md#int) | | +| `is_anchor` - [`Int`](types-f-i.md#int) | | +| `landing_page` - [`Int`](types-f-i.md#int) | | +| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](types-q-s.md#string) | | +| `meta_keywords` - [`String`](types-q-s.md#string) | | +| `meta_title` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | #### Example ```json { - "available_sort_by": ["abc123"], + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "abc123", - "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", - "description": "abc123", - "display_mode": "abc123", + "canonical_url": "abc123", + "children_count": "xyz789", + "custom_layout_update_file": "xyz789", + "default_sort_by": "abc123", + "description": "xyz789", + "display_mode": "xyz789", "filter_price_range": 123.45, "image": "xyz789", "include_in_menu": 987, - "is_anchor": 123, + "is_anchor": 987, "landing_page": 123, - "level": 987, - "meta_description": "abc123", + "level": 123, + "meta_description": "xyz789", "meta_keywords": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "xyz789", - "path": "xyz789", + "path": "abc123", "path_in_store": "xyz789", "position": 123, - "product_count": 123, - "uid": 4, + "product_count": 987, + "uid": "4", "url_key": "xyz789", "url_path": "xyz789" } @@ -1131,37 +1131,37 @@ Represents a category. Contains information about a category, including the cate | 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.)* | +| `availableSortBy` - [`[String]`](types-q-s.md#string) | List of available sort by options. For example, `name`, `position` or `size`. | +| `children` - [`[String!]`](types-q-s.md#string) | List of child category IDs. For example, `123`, `456` or `789`. | +| `defaultSortBy` - [`String`](types-q-s.md#string) | Default sort by option. For example, `name`, `position` or `size`. | +| `id` - [`ID!`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | +| `parentId` - [`String!`](types-q-s.md#string) | Parent category ID. For example, `123`, `456` or `789`. | +| `position` - [`Int`](types-f-i.md#int) | The position of the category in sort order. For example, `1`, `2`, `3` or `10`. | +| `path` - [`String`](types-q-s.md#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!]!`](types-q-s.md#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `urlKey` - [`String`](types-q-s.md#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | +| `urlPath` - [`String`](types-q-s.md#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | +| `count` - [`Int!`](types-f-i.md#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!`](types-q-s.md#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": ["abc123"], - "defaultSortBy": "xyz789", + "children": ["xyz789"], + "defaultSortBy": "abc123", "id": 4, - "level": 123, - "name": "abc123", + "level": 987, + "name": "xyz789", "parentId": "abc123", "position": 123, "path": "abc123", - "roles": ["xyz789"], + "roles": ["abc123"], "urlKey": "abc123", - "urlPath": "abc123", + "urlPath": "xyz789", "count": 987, "title": "abc123" } @@ -1177,15 +1177,15 @@ Base interface defining essential category fields shared across all category vie | 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`. | +| `availableSortBy` - [`[String]`](types-q-s.md#string) | List of available sort by options. For example, name, size or position. | +| `defaultSortBy` - [`String`](types-q-s.md#string) | Default sort by option. For example, name, size or position. | +| `id` - [`ID!`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | +| `path` - [`String`](types-q-s.md#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | +| `roles` - [`[String]`](types-q-s.md#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `urlKey` - [`String`](types-q-s.md#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | +| `urlPath` - [`String`](types-q-s.md#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | #### Possible Types @@ -1197,15 +1197,15 @@ Base interface defining essential category fields shared across all category vie ```json { - "availableSortBy": ["xyz789"], - "defaultSortBy": "abc123", + "availableSortBy": ["abc123"], + "defaultSortBy": "xyz789", "id": "4", "level": 987, - "name": "abc123", + "name": "xyz789", "path": "xyz789", "roles": ["xyz789"], "urlKey": "abc123", - "urlPath": "xyz789" + "urlPath": "abc123" } ``` @@ -1219,25 +1219,25 @@ Defines details about an individual checkout agreement. | 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. | +| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](types-a-b.md#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. | +| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | #### Example ```json { "agreement_id": 987, - "checkbox_text": "abc123", - "content": "xyz789", - "content_height": "xyz789", + "checkbox_text": "xyz789", + "content": "abc123", + "content_height": "abc123", "is_html": false, "mode": "AUTO", - "name": "xyz789" + "name": "abc123" } ``` @@ -1271,8 +1271,8 @@ An error encountered while adding an item to the cart. | 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 | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](types-q-s.md#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 @@ -1280,7 +1280,7 @@ An error encountered while adding an item to the cart. { "code": "REORDER_NOT_AVAILABLE", "message": "abc123", - "path": ["xyz789"] + "path": ["abc123"] } ``` @@ -1315,7 +1315,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -1331,9 +1331,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -1352,7 +1352,7 @@ Contains details about a failed close operation on a negotiable quote. | 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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1371,7 +1371,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1390,12 +1390,12 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{"quote_uids": [4]} +{"quote_uids": ["4"]} ``` @@ -1408,9 +1408,9 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1432,12 +1432,12 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1450,12 +1450,12 @@ Commerce Optimizer entities | Field Name | Description | |------------|-------------| -| `priceBookId` - [`ID!`](#id) | The priceBookId for current customer session. | +| `priceBookId` - [`ID!`](types-f-i.md#id) | The priceBookId for current customer session. | #### Example ```json -{"priceBookId": 4} +{"priceBookId": "4"} ``` @@ -1487,7 +1487,7 @@ Specifies which field to sort on, and whether to return the results in ascending | 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. | +| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1506,19 +1506,19 @@ Contains the output schema for a company. | 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_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](types-f-i.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](types-q-s.md#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. | @@ -1527,7 +1527,7 @@ Contains the output schema for a company. | `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. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1543,12 +1543,12 @@ Contains the output schema for a company. "credit_history": CompanyCreditHistory, "custom_attributes": [CustomAttribute], "email": "xyz789", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "xyz789", + "name": "abc123", "payment_methods": ["abc123"], - "reseller_id": "abc123", + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1572,17 +1572,17 @@ Contains details about the access control list settings of a resource. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | #### Example ```json { "children": [CompanyAclResource], - "id": 4, - "sort_order": 987, + "id": "4", + "sort_order": 123, "text": "xyz789" } ``` @@ -1597,25 +1597,25 @@ Defines the input schema for creating a company administrator. | 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. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company administrator. | #### Example ```json { "custom_attributes": [AttributeValueInput], - "email": "abc123", - "firstname": "xyz789", + "email": "xyz789", + "firstname": "abc123", "gender": 987, - "job_title": "xyz789", + "job_title": "abc123", "lastname": "abc123", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1629,8 +1629,8 @@ Describes a carrier-level shipping option available to the company. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | | -| `title` - [`String!`](#string) | | +| `code` - [`String!`](types-q-s.md#string) | | +| `title` - [`String!`](types-q-s.md#string) | | #### Example @@ -1651,10 +1651,10 @@ The minimal required information to identify and display the company. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `is_admin` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company is the admin (parent) company in the returned relation hierarchy. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](types-q-s.md#string) | The name of the company. | | `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | #### Example @@ -1663,8 +1663,8 @@ The minimal required information to identify and display the company. { "id": 4, "is_admin": false, - "legal_name": "abc123", - "name": "abc123", + "legal_name": "xyz789", + "name": "xyz789", "status": "PENDING" } ``` @@ -1680,12 +1680,12 @@ Defines the input schema for creating a new company. | 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. | +| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1693,10 +1693,10 @@ Defines the input schema for creating a new company. { "company_admin": CompanyAdminInput, "company_email": "xyz789", - "company_name": "abc123", + "company_name": "xyz789", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "xyz789", - "reseller_id": "abc123", + "legal_name": "abc123", + "reseller_id": "xyz789", "vat_tax_id": "xyz789" } ``` @@ -1711,10 +1711,10 @@ Contains company credit balances and limits. | 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. | +| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | +| `exceed_limit` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether company credit functionality is allowed to exceed current company credit limit. | +| `outstanding_balance` - [`Money!`](types-k-p.md#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 @@ -1722,7 +1722,7 @@ Contains company credit balances and limits. { "available_credit": Money, "credit_limit": Money, - "exceed_limit": false, + "exceed_limit": true, "outstanding_balance": Money } ``` @@ -1738,8 +1738,8 @@ Contains details about prior company credit operations. | 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. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1761,9 +1761,9 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](types-q-s.md#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. | +| `updated_by` - [`String`](types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example @@ -1771,7 +1771,7 @@ Defines a filter for narrowing the results of a credit history search. { "custom_reference_number": "abc123", "operation_type": "ALLOCATION", - "updated_by": "xyz789" + "updated_by": "abc123" } ``` @@ -1785,10 +1785,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `amount` - [`Money`](types-k-p.md#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. | +| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](types-q-s.md#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. | @@ -1836,13 +1836,13 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](types-q-s.md#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"} +{"name": "xyz789", "type": "CUSTOMER"} ``` @@ -1894,8 +1894,8 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | +| `code` - [`String!`](types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example @@ -1903,7 +1903,7 @@ Defines the input schema for accepting the company invitation. ```json { "code": "abc123", - "role_id": "4", + "role_id": 4, "user": CompanyInvitationUserInput } ``` @@ -1918,12 +1918,12 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -1936,21 +1936,21 @@ Company user attributes in the invitation. | 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. | +| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | #### Example ```json { - "company_id": 4, - "customer_id": 4, + "company_id": "4", + "customer_id": "4", "job_title": "xyz789", "status": "ACTIVE", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1964,12 +1964,12 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | #### Example @@ -1979,8 +1979,8 @@ Contains details about the address where the company is registered to conduct bu "country_code": "AF", "postcode": "xyz789", "region": CustomerAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" + "street": ["abc123"], + "telephone": "abc123" } ``` @@ -1994,12 +1994,12 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](types-q-s.md#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. | +| `postcode` - [`String!`](types-q-s.md#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. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2009,8 +2009,8 @@ Defines the input schema for defining a company's legal address. "country_id": "AF", "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -2024,12 +2024,12 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](types-q-s.md#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. | +| `postcode` - [`String`](types-q-s.md#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. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2037,9 +2037,9 @@ Defines the input schema for updating a company's legal address. { "city": "abc123", "country_id": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput, - "street": ["abc123"], + "street": ["xyz789"], "telephone": "abc123" } ``` @@ -2054,19 +2054,19 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#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. | +| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { - "id": 4, - "name": "xyz789", + "id": "4", + "name": "abc123", "permissions": [CompanyAclResource], - "users_count": 123 + "users_count": 987 } ``` @@ -2080,15 +2080,15 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]`](#string) | A list of resources the role can access. | +| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { "name": "abc123", - "permissions": ["xyz789"] + "permissions": ["abc123"] } ``` @@ -2102,15 +2102,15 @@ Defines the input schema for updating a company role. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "id": "4", + "id": 4, "name": "xyz789", "permissions": ["xyz789"] } @@ -2127,8 +2127,8 @@ Contains an array of roles. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2136,7 +2136,7 @@ Contains an array of roles. { "items": [CompanyRole], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2150,16 +2150,16 @@ Contains details about a company sales representative. | 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. | +| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "abc123", - "firstname": "abc123", + "email": "xyz789", + "firstname": "xyz789", "lastname": "abc123" } ``` @@ -2231,8 +2231,8 @@ Defines an individual node in the company structure. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example @@ -2254,13 +2254,13 @@ Defines the input schema for updating the company structure. | 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. | +| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": "4", "tree_id": 4} +{"parent_tree_id": 4, "tree_id": "4"} ``` @@ -2273,10 +2273,10 @@ Describes a company team. | 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 | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | #### Example @@ -2285,7 +2285,7 @@ Describes a company team. "description": "xyz789", "id": "4", "name": "xyz789", - "structure_id": 4 + "structure_id": "4" } ``` @@ -2299,17 +2299,17 @@ Defines the input schema for creating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "name": "xyz789", - "target_id": 4 + "target_id": "4" } ``` @@ -2323,9 +2323,9 @@ Defines the input schema for updating a company team. | 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. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](types-q-s.md#string) | The display name of the team. | #### Example @@ -2347,22 +2347,22 @@ Defines the input schema for updating a company. | 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. | +| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](types-q-s.md#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. | +| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "company_email": "abc123", - "company_name": "xyz789", + "company_email": "xyz789", + "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "abc123", - "reseller_id": "abc123", + "legal_name": "xyz789", + "reseller_id": "xyz789", "vat_tax_id": "xyz789" } ``` @@ -2377,26 +2377,26 @@ Defines the input schema for creating a company user. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](types-f-i.md#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. | +| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "job_title": "xyz789", "lastname": "xyz789", "role_id": "4", "status": "ACTIVE", - "target_id": 4, + "target_id": "4", "telephone": "xyz789" } ``` @@ -2430,14 +2430,14 @@ Defines the input schema for updating a company user. | 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. | +| `email` - [`String`](types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](types-f-i.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | #### Example @@ -2446,11 +2446,11 @@ Defines the input schema for updating a company user. "email": "abc123", "firstname": "abc123", "id": "4", - "job_title": "xyz789", + "job_title": "abc123", "lastname": "xyz789", - "role_id": 4, + "role_id": "4", "status": "ACTIVE", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2465,8 +2465,8 @@ Contains details about company users. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | #### Example @@ -2474,7 +2474,7 @@ Contains details about company users. { "items": [Customer], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2506,14 +2506,14 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "abc123" } ``` @@ -2528,9 +2528,9 @@ Defines an object used to iterate through items for product comparisons. | 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. | +| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2553,16 +2553,16 @@ Contains iterable information such as the array of items, the count, and attribu | 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. | +| `item_count` - [`Int!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -2578,15 +2578,15 @@ Update the quote and complete the order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | #### Example ```json { - "cartId": "abc123", - "id": "abc123" + "cartId": "xyz789", + "id": "xyz789" } ``` @@ -2600,30 +2600,30 @@ Represents all product types, except simple products. Complex product prices are | 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. | +| `addToCartAllowed` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](types-a-b.md#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]`](types-k-p.md#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. | +| `description` - [`String`](types-q-s.md#string) | The detailed description of the product. | +| `id` - [`ID!`](types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | +| `images` - [`[ProductViewImage]`](types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image` or `swatch`. | +| `videos` - [`[ProductViewVideo]`](types-k-p.md#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 | +| `metaDescription` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings. | +| `metaKeyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `metaTitle` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | Product name. | +| `inputOptions` - [`[ProductViewInputOption]`](types-k-p.md#productviewinputoption) | A list of input options. *(Deprecated: This field is deprecated and will be removed.)* | +| `options` - [`[ProductViewOption]`](types-k-p.md#productviewoption) | A list of selectable options. | +| `priceRange` - [`ProductViewPriceRange`](types-k-p.md#productviewpricerange) | A range of possible prices for a complex product. | +| `shortDescription` - [`String`](types-q-s.md#string) | A summary of the product. | +| `sku` - [`String`](types-q-s.md#string) | A unique code used for identification of a product. | +| `externalId` - [`String`](types-q-s.md#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | +| `url` - [`String`](types-q-s.md#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | +| `urlKey` - [`String`](types-q-s.md#string) | The URL key of the product. | +| `links` - [`[ProductViewLink]`](types-k-p.md#productviewlink) | A list of product links. Links are used to navigate from one product to another. | +| `queryType` - [`String`](types-q-s.md#string) | Indicates if the product was retrieved from the primary or the backup query | +| `visibility` - [`String`](types-q-s.md#string) | Visibility setting of the product | #### Example @@ -2631,24 +2631,24 @@ Represents all product types, except simple products. Complex product prices are { "addToCartAllowed": true, "inStock": true, - "lowStock": false, + "lowStock": true, "attributes": [ProductViewAttribute], - "description": "xyz789", + "description": "abc123", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", - "metaKeyword": "abc123", - "metaTitle": "xyz789", + "metaDescription": "xyz789", + "metaKeyword": "xyz789", + "metaTitle": "abc123", "name": "xyz789", "inputOptions": [ProductViewInputOption], "options": [ProductViewOption], "priceRange": ProductViewPriceRange, "shortDescription": "abc123", - "sku": "xyz789", - "externalId": "abc123", - "url": "abc123", + "sku": "abc123", + "externalId": "xyz789", + "url": "xyz789", "urlKey": "abc123", "links": [ProductViewLink], "queryType": "abc123", @@ -2664,12 +2664,12 @@ Represents all product types, except simple products. Complex product prices are | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | #### Example ```json -{"html": "abc123"} +{"html": "xyz789"} ``` @@ -2680,9 +2680,9 @@ Represents all product types, except simple products. Complex product prices are | Input Field | Description | |-------------|-------------| -| `field` - [`Field`](#field) | | -| `operator` - [`OperatorInput`](#operatorinput) | | -| `enabled` - [`Boolean`](#boolean) | | +| `field` - [`Field`](types-f-i.md#field) | | +| `operator` - [`OperatorInput`](types-k-p.md#operatorinput) | | +| `enabled` - [`Boolean`](types-a-b.md#boolean) | | #### Example @@ -2704,19 +2704,19 @@ Contains details about a configurable product attribute option. | 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. | +| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "code": "abc123", - "label": "abc123", - "uid": 4, - "value_index": 123 + "code": "xyz789", + "label": "xyz789", + "uid": "4", + "value_index": 987 } ``` @@ -2730,34 +2730,34 @@ An implementation for configurable product cart items. | 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. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](types-k-p.md#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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", + "backorder_message": "xyz789", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "custom_attributes": [CustomAttribute], @@ -2766,11 +2766,11 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, - "is_salable": true, + "is_available": true, + "is_salable": false, "max_qty": 987.65, "min_qty": 987.65, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -2790,15 +2790,15 @@ Describes configurable options that have been selected and can be selected as a | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { - "attribute_code": "abc123", - "option_value_uids": ["4"] + "attribute_code": "xyz789", + "option_value_uids": [4] } ``` @@ -2812,28 +2812,28 @@ Describes configurable options that have been selected and can be selected as a |------------|-------------| | `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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -2845,24 +2845,24 @@ Describes configurable options that have been selected and can be selected as a "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, "quantity_return_requested": 123.45, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -2876,56 +2876,56 @@ Defines basic features of a configurable product and its simple product variants | 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. | +| `canonical_url` - [`String`](types-q-s.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](types-k-p.md#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 | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](types-q-s.md#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. | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, @@ -2933,42 +2933,42 @@ Defines basic features of a configurable product and its simple product variants "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, + "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, + "is_returnable": "xyz789", + "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "min_sale_qty": 123.45, + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, - "special_to_date": "xyz789", + "special_price": 123.45, + "special_to_date": "abc123", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "variants": [ConfigurableVariant], - "weight": 123.45 + "weight": 987.65 } ``` @@ -2982,9 +2982,9 @@ Contains details about configurable product options. | 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. | +| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the configurable option. | | `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example @@ -2992,7 +2992,7 @@ Contains details about configurable product options. ```json { "attribute_code": "xyz789", - "label": "abc123", + "label": "xyz789", "uid": "4", "values": [ConfigurableProductOptionValue] } @@ -3008,21 +3008,21 @@ Defines a value for a configurable product option. | 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. | +| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | #### Example ```json { - "is_available": false, + "is_available": true, "is_use_default": true, - "label": "xyz789", + "label": "abc123", "swatch": SwatchDataInterface, - "uid": "4" + "uid": 4 } ``` @@ -3036,12 +3036,12 @@ Defines configurable attributes for the specified product. | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](types-a-b.md#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 @@ -3051,9 +3051,9 @@ Defines configurable attributes for the specified product. "attribute_code": "abc123", "attribute_uid": 4, "label": "xyz789", - "position": 123, + "position": 987, "uid": 4, - "use_default": false, + "use_default": true, "values": [ConfigurableProductOptionsValues] } ``` @@ -3069,9 +3069,9 @@ Contains metadata corresponding to the selected configurable options. | 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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#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. | +| `variant` - [`SimpleProduct`](types-q-s.md#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 @@ -3096,20 +3096,20 @@ Contains the index number assigned to a configurable product option. | 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. | +| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | #### Example ```json { - "default_label": "abc123", + "default_label": "xyz789", "label": "abc123", - "store_label": "xyz789", + "store_label": "abc123", "swatch_data": SwatchDataInterface, "uid": 4, "use_default_value": true @@ -3126,12 +3126,12 @@ Contains details about configurable products added to a requisition list. | 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. | +| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -3157,7 +3157,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -3178,27 +3178,27 @@ A configurable product wish list 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -3210,8 +3210,8 @@ A configurable product wish list item. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | #### Example @@ -3232,15 +3232,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | #### Example ```json { "confirmation_key": "xyz789", - "email": "xyz789" + "email": "abc123" } ``` @@ -3252,8 +3252,8 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | #### Example @@ -3291,19 +3291,19 @@ List of account confirmation statuses. | 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. | +| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | #### Example ```json { - "comment": "abc123", - "email": "xyz789", + "comment": "xyz789", + "email": "abc123", "name": "xyz789", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -3317,12 +3317,12 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example ```json -{"status": false} +{"status": true} ``` @@ -3335,12 +3335,12 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -3353,7 +3353,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3371,9 +3371,9 @@ Contains the source and target wish lists after copying products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3393,22 +3393,22 @@ Contains the source and target wish lists after copying products. | 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. | +| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { "available_regions": [Region], - "full_name_english": "xyz789", + "full_name_english": "abc123", "full_name_locale": "xyz789", "id": "abc123", - "three_letter_abbreviation": "xyz789", + "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" } ``` @@ -3757,7 +3757,7 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example @@ -3775,14 +3775,14 @@ Defines a new gift registry. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3791,9 +3791,9 @@ Defines a new gift registry. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "abc123", - "gift_registry_type_uid": 4, - "message": "xyz789", + "event_name": "xyz789", + "gift_registry_type_uid": "4", + "message": "abc123", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -3811,7 +3811,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3827,7 +3827,7 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | #### Example @@ -3861,19 +3861,19 @@ Contains payment order details that are used while processing the payment order | 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 | +| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example ```json { - "cartId": "xyz789", + "cartId": "abc123", "location": "PRODUCT_DETAIL", - "methodCode": "xyz789", + "methodCode": "abc123", "paymentSource": "abc123", "vaultIntent": true } @@ -3889,19 +3889,19 @@ Contains payment order details that are used while processing the payment order | 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 | +| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example ```json { - "amount": 987.65, + "amount": 123.45, "currency_code": "abc123", - "id": "abc123", + "id": "xyz789", "mp_order_id": "xyz789", "status": "abc123" } @@ -3918,12 +3918,12 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example ```json -{"currency": "AFN", "value": 123.45} +{"currency": "AFN", "value": 987.65} ``` @@ -3937,9 +3937,9 @@ Defines a set of conditions that apply to a rule. | 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. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -3948,7 +3948,7 @@ Defines a set of conditions that apply to a rule. "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, "attribute": "GRAND_TOTAL", "operator": "MORE_THAN", - "quantity": 987 + "quantity": 123 } ``` @@ -3962,15 +3962,15 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { "description": "abc123", - "name": "abc123" + "name": "xyz789" } ``` @@ -3984,7 +3984,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -4002,15 +4002,15 @@ Describe the variables needed to create a vault payment token | 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 | +| `card_description` - [`String`](types-q-s.md#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example ```json { "card_description": "abc123", - "setup_token_id": "abc123" + "setup_token_id": "xyz789" } ``` @@ -4024,8 +4024,8 @@ The vault token id and information about the payment source | Field Name | Description | |------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](#string) | The vault payment token information | +| `payment_source` - [`PaymentSourceOutput!`](types-k-p.md#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](types-q-s.md#string) | The vault payment token information | #### Example @@ -4046,8 +4046,8 @@ Describe the variables needed to create a vault card setup token | Input Field | Description | |-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | +| `setup_token` - [`VaultSetupTokenInput!`](types-t-z.md#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | The 3DS mode | #### Example @@ -4068,7 +4068,7 @@ The setup token id information | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](#string) | The setup token id | +| `setup_token` - [`String!`](types-q-s.md#string) | The setup token id | #### Example @@ -4086,8 +4086,8 @@ Defines the name and visibility of a new wish list. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -4105,7 +4105,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -4123,11 +4123,11 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#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. | +| `id` - [`ID!`](types-f-i.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -4153,7 +4153,7 @@ Defines a credit memo item's custom attributes. | Input Field | Description | |-------------|-------------| -| `credit_memo_id` - [`String!`](#string) | The credit memo ID. | +| `credit_memo_id` - [`String!`](types-q-s.md#string) | The credit memo ID. | | `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for the credit memo. | #### Example @@ -4175,12 +4175,12 @@ 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. | -| `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -4188,12 +4188,12 @@ Defines a credit memo item's custom attributes. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -4207,15 +4207,15 @@ Defines a credit memo's custom attributes. | Input Field | Description | |-------------|-------------| -| `credit_memo_id` - [`String!`](#string) | The credit memo ID. | -| `credit_memo_item_id` - [`String!`](#string) | The credit memo item ID. | +| `credit_memo_id` - [`String!`](types-q-s.md#string) | The credit memo ID. | +| `credit_memo_item_id` - [`String!`](types-q-s.md#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_id": "xyz789", "credit_memo_item_id": "xyz789", "custom_attributes": [CustomAttributeInput] } @@ -4233,21 +4233,21 @@ Credit memo item details. |------------|-------------| | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | +| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | #### Example @@ -4257,9 +4257,9 @@ Credit memo item details. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 123.45 } ``` @@ -4292,15 +4292,15 @@ Contains credit memo price details. | 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. | +| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](types-k-p.md#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. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4326,11 +4326,11 @@ Contains credit memo price details. | 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 $. | +| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](types-q-s.md#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 @@ -4339,7 +4339,7 @@ Contains credit memo price details. { "available_currency_codes": ["xyz789"], "base_currency_code": "abc123", - "base_currency_symbol": "xyz789", + "base_currency_symbol": "abc123", "default_display_currency_code": "xyz789", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] @@ -4542,13 +4542,13 @@ Attributes of the product currently being viewed on PDP | Input Field | Description | |-------------|-------------| -| `sku` - [`String`](#string) | SKU of the current product | -| `price` - [`Float`](#float) | Resolved display price of the current product (specialPrice ?? regularPrice) | +| `sku` - [`String`](types-q-s.md#string) | SKU of the current product | +| `price` - [`Float`](types-f-i.md#float) | Resolved display price of the current product (specialPrice ?? regularPrice) | #### Example ```json -{"sku": "xyz789", "price": 987.65} +{"sku": "abc123", "price": 987.65} ``` @@ -4561,8 +4561,8 @@ Specifies the custom attribute code and value. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The custom attribute code. | -| `value` - [`String`](#string) | The custom attribute code value. | +| `attribute_code` - [`String`](types-q-s.md#string) | The custom attribute code. | +| `value` - [`String`](types-q-s.md#string) | The custom attribute code value. | #### Example @@ -4583,14 +4583,14 @@ Defines a custom attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | Attribute Code. | -| `value` - [`String!`](#string) | Attribute Value. | +| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute Code. | +| `value` - [`String!`](types-q-s.md#string) | Attribute Value. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "abc123" } ``` @@ -4605,37 +4605,37 @@ An interface containing fields that define the EAV attribute. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](#attributemetadata) | +| [`AttributeMetadata`](types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | #### Example ```json { "code": 4, - "default_value": "abc123", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_required": true, "is_unique": true, - "label": "xyz789", + "label": "abc123", "options": [CustomAttributeOptionInterface] } ``` @@ -4648,23 +4648,23 @@ An interface containing fields that define the EAV attribute. | 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. | +| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | #### Example ```json { - "is_default": false, + "is_default": true, "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -4678,8 +4678,8 @@ A simple key value object. | Field Name | Description | |------------|-------------| -| `key` - [`String`](#string) | | -| `value` - [`String`](#string) | | +| `key` - [`String`](types-q-s.md#string) | | +| `value` - [`String`](types-q-s.md#string) | | #### Example @@ -4699,7 +4699,7 @@ A simple key value object. | Input Field | Description | |-------------|-------------| | `type` - [`CustomOperatorType`](#customoperatortype) | | -| `value` - [`[String]`](#string) | | +| `value` - [`[String]`](types-q-s.md#string) | | #### Example @@ -4739,52 +4739,52 @@ Defines the customer name, addresses, and other details. |------------|-------------| | `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. | +| `admin_assistance_actions` - [`AdminAssistanceActions!`](types-a-b.md#adminassistanceactions) | Actions performed by an admin on behalf of the customer (Login as Customer logging). | +| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](types-t-z.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | +| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#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. | +| `id` - [`ID!`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#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. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | +| `reward_points` - [`RewardPoints`](types-q-s.md#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). | +| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#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. | +| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#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 @@ -4793,7 +4793,7 @@ Defines the customer name, addresses, and other details. "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, @@ -4801,16 +4801,16 @@ Defines the customer name, addresses, and other details. "created_at": "abc123", "custom_attributes": [AttributeValueInterface], "date_of_birth": "xyz789", - "default_billing": "abc123", - "default_shipping": "abc123", - "email": "xyz789", - "firstname": "abc123", + "default_billing": "xyz789", + "default_shipping": "xyz789", + "email": "abc123", + "firstname": "xyz789", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": 4, - "is_subscribed": false, + "id": "4", + "is_subscribed": true, "job_title": "xyz789", "lastname": "xyz789", "middlename": "abc123", @@ -4821,8 +4821,8 @@ Defines the customer name, addresses, and other details. "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, - "quote_enabled": false, + "purchase_orders_enabled": true, + "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -4831,8 +4831,8 @@ Defines the customer name, addresses, and other details. "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "abc123", + "structure_id": 4, + "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, "telephone": "xyz789", @@ -4851,52 +4851,52 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#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. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CustomerAddress` object. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, + "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", - "id": 123, + "id": 987, "lastname": "abc123", "middlename": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, + "telephone": "abc123", + "uid": "4", "vat_id": "xyz789" } ``` @@ -4911,14 +4911,14 @@ Specifies the attribute code and value of a customer address attribute. | 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. | +| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "abc123" } ``` @@ -4933,45 +4933,45 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | +| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributesV2` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInput], - "default_billing": false, + "default_billing": true, "default_shipping": true, "fax": "xyz789", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "abc123", "middlename": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegionInput, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -4985,17 +4985,17 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "xyz789", + "region": "abc123", "region_code": "abc123", - "region_id": 987 + "region_id": 123 } ``` @@ -5009,16 +5009,16 @@ Defines the customer's state or province. | 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. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "xyz789", - "region_code": "abc123", + "region": "abc123", + "region_code": "xyz789", "region_id": 987 } ``` @@ -5032,8 +5032,8 @@ Defines the customer's state or province. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer addresses. | #### Example @@ -5041,7 +5041,7 @@ Defines the customer's state or province. { "items": [CustomerAddress], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5055,19 +5055,19 @@ Customer attribute metadata. | 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. | +| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](types-f-i.md#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. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example @@ -5076,7 +5076,7 @@ Customer attribute metadata. "code": "4", "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", "is_required": true, @@ -5084,7 +5084,7 @@ Customer attribute metadata. "label": "xyz789", "multiline_count": 987, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -5099,37 +5099,37 @@ An input object for creating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "email": "xyz789", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "is_subscribed": false, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", "password": "abc123", "prefix": "xyz789", "suffix": "abc123", - "taxvat": "xyz789" + "taxvat": "abc123" } ``` @@ -5143,20 +5143,20 @@ Contains details about a single downloadable product. | 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`. | +| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "date": "abc123", + "date": "xyz789", "download_url": "abc123", - "order_increment_id": "xyz789", - "remaining_downloads": "xyz789", + "order_increment_id": "abc123", + "remaining_downloads": "abc123", "status": "xyz789" } ``` @@ -5189,12 +5189,12 @@ Data of customer group. | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerGroup` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerGroup` object. | #### Example ```json -{"uid": 4} +{"uid": "4"} ``` @@ -5207,56 +5207,56 @@ Contains details about each of the customer's orders. | 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. | +| `admin_assisted_order` - [`Int`](types-f-i.md#int) | Admin user id when the order was placed with assistance (Login as Customer); null if not assisted. | +| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](types-k-p.md#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#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, +| `customer_info` - [`OrderCustomerInfo!`](types-k-p.md#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `negotiable_quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote associated with this order. | +| `number` - [`String!`](types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | +| `order_status_change_date` - [`String!`](types-q-s.md#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](types-k-p.md#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": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, "invoices": [Invoice], @@ -5265,15 +5265,15 @@ Contains details about each of the customer's orders. "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, "number": "xyz789", - "order_date": "xyz789", + "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", + "shipping_method": "xyz789", + "status": "xyz789", "token": "abc123", "total": OrderTotal } @@ -5289,7 +5289,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](types-q-s.md#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 @@ -5327,19 +5327,19 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| -| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | +| `date_of_first_order` - [`String`](types-q-s.md#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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | #### Example ```json { - "date_of_first_order": "xyz789", + "date_of_first_order": "abc123", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5353,10 +5353,10 @@ Identifies the filter to use for filtering orders. | 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. | +| `grand_total` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filters by order status. | #### Example @@ -5397,7 +5397,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5415,7 +5415,7 @@ Customer segment details | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerSegment` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerSegment` object. | #### Example @@ -5434,8 +5434,8 @@ Contains store credit information with balance and history. | 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. | +| `current_balance` - [`Money`](types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5443,7 +5443,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -5458,8 +5458,8 @@ Lists changes to the amount of store credit available to the customer. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | #### Example @@ -5467,7 +5467,7 @@ Lists changes to the amount of store credit available to the customer. { "items": [CustomerStoreCreditHistoryItem], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5481,19 +5481,19 @@ Contains store credit history information. | 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. | +| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | #### Example ```json { - "action": "xyz789", + "action": "abc123", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "abc123" + "date_time_changed": "xyz789" } ``` @@ -5507,7 +5507,7 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | +| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | #### Example @@ -5525,33 +5525,33 @@ An input object for updating a customer. | 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). | +| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | +| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], "date_of_birth": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "gender": 987, - "is_subscribed": true, + "is_subscribed": false, "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "prefix": "abc123", - "suffix": "abc123", - "taxvat": "xyz789" + "suffix": "xyz789", + "taxvat": "abc123" } ``` @@ -5565,20 +5565,20 @@ Contains information about a text area that is defined as part of a customizable | 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. | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "product_sku": "abc123", + "product_sku": "xyz789", "required": true, - "sort_order": 987, + "sort_order": 123, "title": "xyz789", "uid": 4, "value": CustomizableAreaValue @@ -5595,18 +5595,18 @@ Defines the price and sku of a product whose page contains a customized text are | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { "max_characters": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", "uid": "4" @@ -5623,18 +5623,18 @@ Contains information about a set of checkbox values that are defined as part of | 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. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example ```json { - "required": true, - "sort_order": 123, + "required": false, + "sort_order": 987, "title": "xyz789", "uid": 4, "value": [CustomizableCheckboxValue] @@ -5651,25 +5651,25 @@ Defines the price and sku of a product whose page contains a customized set of c | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 987, - "title": "abc123", - "uid": 4 + "sku": "abc123", + "sort_order": 123, + "title": "xyz789", + "uid": "4" } ``` @@ -5683,22 +5683,22 @@ Contains information about a date picker that is defined as part of a customizab | 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. | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": "abc123", - "required": false, + "product_sku": "xyz789", + "required": true, "sort_order": 987, - "title": "xyz789", - "uid": 4, + "title": "abc123", + "uid": "4", "value": CustomizableDateValue } ``` @@ -5733,11 +5733,11 @@ Defines the price and sku of a product whose page contains a customized date pic | 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. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example @@ -5745,7 +5745,7 @@ Defines the price and sku of a product whose page contains a customized date pic { "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "type": "DATE", "uid": "4" } @@ -5761,10 +5761,10 @@ Contains information about a drop down menu that is defined as part of a customi | 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. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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 @@ -5772,7 +5772,7 @@ Contains information about a drop down menu that is defined as part of a customi ```json { "required": false, - "sort_order": 123, + "sort_order": 987, "title": "abc123", "uid": 4, "value": [CustomizableDropDownValue] @@ -5789,23 +5789,23 @@ Defines the price and sku of a product whose page contains a customized drop dow | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "option_type_id": 987, - "price": 987.65, + "option_type_id": 123, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", - "sort_order": 123, + "sku": "xyz789", + "sort_order": 987, "title": "abc123", "uid": "4" } @@ -5821,18 +5821,18 @@ Contains information about a text field that is defined as part of a customizabl | 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. | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "product_sku": "xyz789", + "product_sku": "abc123", "required": true, "sort_order": 987, "title": "abc123", @@ -5851,18 +5851,18 @@ Defines the price and sku of a product whose page contains a customized text fie | 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. | +| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { "max_characters": 123, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", "uid": "4" @@ -5879,11 +5879,11 @@ Contains information about a file picker that is defined as part of a customizab | 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. | +| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -5893,8 +5893,8 @@ Contains information about a file picker that is defined as part of a customizab "product_sku": "abc123", "required": true, "sort_order": 123, - "title": "abc123", - "uid": 4, + "title": "xyz789", + "uid": "4", "value": CustomizableFileValue } ``` @@ -5909,25 +5909,25 @@ Defines the price and sku of a product whose page contains a customized file pic | 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. | +| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "file_extension": "abc123", - "image_size_x": 987, - "image_size_y": 123, - "price": 123.45, + "file_extension": "xyz789", + "image_size_x": 123, + "image_size_y": 987, + "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -5941,18 +5941,18 @@ Contains information about a multiselect that is defined as part of a customizab | 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. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#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": false, - "sort_order": 987, + "required": true, + "sort_order": 123, "title": "xyz789", "uid": "4", "value": [CustomizableMultipleValue] @@ -5969,24 +5969,24 @@ Defines the price and sku of a product whose page contains a customized multisel | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 987.65, "price_type": "FIXED", "sku": "abc123", "sort_order": 987, - "title": "xyz789", + "title": "abc123", "uid": 4 } ``` @@ -6001,13 +6001,13 @@ Defines a customizable option. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](#string) | The string value of the option. | +| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | #### Example ```json -{"uid": 4, "value_string": "xyz789"} +{"uid": 4, "value_string": "abc123"} ``` @@ -6020,10 +6020,10 @@ Contains basic information about a customizable option. It can be implemented by | 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. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -6042,10 +6042,10 @@ Contains basic information about a customizable option. It can be implemented by ```json { - "required": true, + "required": false, "sort_order": 987, "title": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6065,12 +6065,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`BundleProduct`](#bundleproduct) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | | [`ConfigurableProduct`](#configurableproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`VirtualProduct`](#virtualproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | #### Example @@ -6088,17 +6088,17 @@ Contains information about a set of radio buttons that are defined as part of a | 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. | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example ```json { - "required": false, + "required": true, "sort_order": 987, "title": "abc123", "uid": 4, @@ -6116,25 +6116,25 @@ Defines the price and sku of a product whose page contains a customized set of r | 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. | +| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "option_type_id": 123, - "price": 987.65, + "option_type_id": 987, + "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -6160,12 +6160,12 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -6178,7 +6178,7 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example @@ -6196,7 +6196,7 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example @@ -6214,7 +6214,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -6230,9 +6230,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | #### Example @@ -6251,7 +6251,7 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -6270,7 +6270,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -6289,12 +6289,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -6305,7 +6305,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example @@ -6323,9 +6323,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#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. | +| `result_status` - [`BatchMutationStatus!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -6350,7 +6350,7 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example @@ -6371,7 +6371,7 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | +| `message` - [`String`](types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example @@ -6407,7 +6407,7 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example @@ -6443,7 +6443,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6461,8 +6461,8 @@ Indicates whether the request to delete the requisition list was successful. | 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. | +| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example @@ -6480,13 +6480,13 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"status": false, "wishlists": [Wishlist]} +{"status": true, "wishlists": [Wishlist]} ``` @@ -6499,13 +6499,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6514,8 +6514,8 @@ Specifies the discount type and value for quote line item. "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": false, - "label": "xyz789", + "is_discounting_locked": true, + "label": "abc123", "type": "xyz789", "value": 123.45 } @@ -6531,24 +6531,24 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `backorder_message` - [`String`](types-q-s.md#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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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. | +| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -6560,11 +6560,11 @@ An implementation for downloadable product cart items. "discount": [Discount], "errors": [CartItemError], "is_available": false, - "is_salable": false, + "is_salable": true, "links": [DownloadableProductLinks], "max_qty": 123.45, "min_qty": 123.45, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -6588,12 +6588,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | #### Example @@ -6602,12 +6602,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 + "product_sku": "abc123", + "quantity_refunded": 123.45 } ``` @@ -6624,12 +6624,12 @@ Defines downloadable product options for `InvoiceItemInterface`. | `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6638,12 +6638,12 @@ Defines downloadable product options for `InvoiceItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 + "product_sku": "xyz789", + "quantity_invoiced": 123.45 } ``` @@ -6657,16 +6657,16 @@ Defines characteristics of the links for downloadable product. | 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. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json { "sort_order": 123, - "title": "abc123", + "title": "xyz789", "uid": 4 } ``` @@ -6684,27 +6684,27 @@ Defines downloadable product options for `OrderItemInterface`. | `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. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -6722,18 +6722,18 @@ Defines downloadable product options for `OrderItemInterface`. "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "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, + "product_url_key": "xyz789", + "quantity_canceled": 987.65, + "quantity_invoiced": 987.65, + "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": "xyz789" + "status": "abc123" } ``` @@ -6747,56 +6747,56 @@ Defines a product that the shopper downloads. | 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. | +| `canonical_url` - [`String`](types-q-s.md#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. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#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 | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](types-k-p.md#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 | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | #### Example ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], @@ -6816,34 +6816,34 @@ Defines a product that the shopper downloads. "links_purchased_separately": 123, "links_title": "xyz789", "manufacturer": 987, - "max_sale_qty": 987.65, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "min_sale_qty": 123.45, - "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "abc123", + "name": "xyz789", + "new_from_date": "abc123", + "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": 987.65, + "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, "special_price": 987.65, - "special_to_date": "abc123", + "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, "uid": "4", "upsell_products": [ProductInterface], - "url_key": "xyz789" + "url_key": "abc123" } ``` @@ -6883,18 +6883,18 @@ Defines characteristics of a downloadable product. | 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. | +| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { "price": 123.45, - "sample_url": "abc123", + "sample_url": "xyz789", "sort_order": 123, "title": "abc123", "uid": 4 @@ -6911,7 +6911,7 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example @@ -6929,15 +6929,15 @@ Defines characteristics of a downloadable product. | 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. | +| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | #### Example ```json { - "sample_url": "xyz789", + "sample_url": "abc123", "sort_order": 987, "title": "xyz789" } @@ -6953,13 +6953,13 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](types-f-i.md#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. | +| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -6970,7 +6970,7 @@ Contains details about downloadable products added to a requisition list. "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "sku": "abc123", + "sku": "xyz789", "uid": "4" } ``` @@ -6985,13 +6985,13 @@ A downloadable product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example @@ -7000,11 +7000,11 @@ A downloadable product wish list item. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": "4", "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples] } ``` @@ -7019,15 +7019,15 @@ Identifies a quote to be duplicated | 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. | +| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | #### Example ```json { "duplicated_quote_uid": "4", - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -7041,7 +7041,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -7059,8 +7059,8 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | +| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | #### Example @@ -7081,13 +7081,13 @@ Defines a customer-entered option. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | #### Example ```json -{"uid": 4, "value": "xyz789"} +{"uid": 4, "value": "abc123"} ``` @@ -7101,14 +7101,14 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Possible Types | Error Types | |----------------| | [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](#insufficientstockerror) | +| [`InsufficientStockError`](types-f-i.md#insufficientstockerror) | #### Example @@ -7127,20 +7127,20 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -7154,7 +7154,7 @@ Contains details about an address. | 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. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -7162,7 +7162,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput } ``` @@ -7176,8 +7176,8 @@ Contains details about an address. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example @@ -7236,7 +7236,7 @@ Contains customer token for external customer. | Field Name | Description | |------------|-------------| | `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | -| `token` - [`String!`](#string) | The customer authorization token. | +| `token` - [`String!`](types-q-s.md#string) | The customer authorization token. | #### Example @@ -7257,13 +7257,13 @@ Lists the exchange rate. | 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. | +| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "abc123", "rate": 123.45} +{"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 index 9b0613974..734d93c34 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md @@ -6,27 +6,27 @@ | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "code": "abc123", - "is_visible": false, - "payment_intent": "xyz789", + "code": "xyz789", + "is_visible": true, + "payment_intent": "abc123", "payment_source": "abc123", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" } ``` @@ -40,15 +40,15 @@ Fastlane Payment inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `paypal_fastlane_token` - [`String`](types-q-s.md#string) | The single use token from Fastlane | #### Example ```json { "payment_source": "xyz789", - "paypal_fastlane_token": "xyz789" + "paypal_fastlane_token": "abc123" } ``` @@ -85,15 +85,15 @@ Defines a filter that matches the input exactly. | 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"]`. | +| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"] + "eq": "xyz789", + "in": ["abc123"] } ``` @@ -124,7 +124,7 @@ Defines a filter that performs a fuzzy search. | 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` - [`String`](types-q-s.md#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 @@ -143,15 +143,15 @@ Defines a filter that matches a range of values, such as prices or dates. | 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. | +| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example ```json { - "from": "xyz789", - "to": "xyz789" + "from": "abc123", + "to": "abc123" } ``` @@ -163,15 +163,15 @@ Defines a filter that matches a range of values, such as prices or dates. | Input Field | Description | |-------------|-------------| -| `name` - [`String`](#string) | | +| `name` - [`String`](types-q-s.md#string) | | | `type` - [`FilterRuleType`](#filterruletype) | | -| `conditions` - [`[ConditionInput]`](#conditioninput) | | +| `conditions` - [`[ConditionInput]`](types-c-e.md#conditioninput) | | #### Example ```json { - "name": "abc123", + "name": "xyz789", "type": "UNKNOWN_FILTER_RULE_TYPE", "conditions": [ConditionInput] } @@ -205,9 +205,9 @@ Defines a filter for an input string. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example @@ -215,7 +215,7 @@ Defines a filter for an input string. { "eq": "xyz789", "in": ["abc123"], - "match": "xyz789" + "match": "abc123" } ``` @@ -229,38 +229,38 @@ Defines the comparison operators that can be used in a filter. | 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. | +| `eq` - [`String`](types-q-s.md#string) | Equals. | +| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](types-q-s.md#string) | Less than. | +| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](types-q-s.md#string) | Not null. | +| `null` - [`String`](types-q-s.md#string) | Is null. | +| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { - "eq": "xyz789", - "from": "xyz789", + "eq": "abc123", + "from": "abc123", "gt": "abc123", - "gteq": "xyz789", + "gteq": "abc123", "in": ["xyz789"], - "like": "xyz789", + "like": "abc123", "lt": "xyz789", "lteq": "xyz789", - "moreq": "abc123", - "neq": "xyz789", + "moreq": "xyz789", + "neq": "abc123", "nin": ["xyz789"], - "notnull": "abc123", - "null": "abc123", + "notnull": "xyz789", + "null": "xyz789", "to": "abc123" } ``` @@ -275,17 +275,17 @@ Contains product attributes that can be used for filtering in a `productSearch` | 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 | +| `attribute` - [`String!`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters and without spaces | +| `frontendInput` - [`String`](types-q-s.md#string) | Indicates how field rendered on storefront | +| `label` - [`String`](types-q-s.md#string) | The display name assigned to the attribute | +| `numeric` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | #### Example ```json { "attribute": "xyz789", - "frontendInput": "xyz789", + "frontendInput": "abc123", "label": "abc123", "numeric": true } @@ -301,15 +301,15 @@ A single FPT that can be applied to a product price. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example ```json { "amount": Money, - "label": "abc123" + "label": "xyz789" } ``` @@ -357,7 +357,7 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example @@ -375,12 +375,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | +| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "abc123"} +{"customer_token": "xyz789"} ``` @@ -398,7 +398,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -416,7 +416,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": "4"} +{"negotiable_quote_uid": 4} ``` @@ -429,7 +429,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -447,17 +447,17 @@ Contains details about the gift card account. | 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. | +| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } ``` @@ -471,7 +471,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | #### Example @@ -500,10 +500,10 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { "attribute_id": 123, - "uid": 4, - "value": 987.65, + "uid": "4", + "value": 123.45, "website_id": 987, - "website_value": 987.65 + "website_value": 123.45 } ``` @@ -517,30 +517,30 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `amount` - [`Money!`](types-k-p.md#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 | +| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#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. | +| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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. | +| `message` - [`String`](types-q-s.md#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. | +| `not_available_message` - [`String`](types-q-s.md#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.)* | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#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. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -557,9 +557,9 @@ Contains details about a gift card that has been added to a cart. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": true, - "is_salable": false, - "max_qty": 987.65, - "message": "xyz789", + "is_salable": true, + "max_qty": 123.45, + "message": "abc123", "min_qty": 987.65, "not_available_message": "abc123", "note_from_buyer": [ItemNote], @@ -568,10 +568,10 @@ Contains details about a gift card that has been added to a cart. "product": ProductInterface, "quantity": 987.65, "recipient_email": "abc123", - "recipient_name": "abc123", - "sender_email": "abc123", + "recipient_name": "xyz789", + "sender_email": "xyz789", "sender_name": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -583,14 +583,14 @@ Contains details about a gift card that has been added to a cart. | 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. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -602,10 +602,10 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 + "product_sku": "abc123", + "quantity_refunded": 987.65 } ``` @@ -617,14 +617,14 @@ Contains details about a gift card that has been added to a cart. | 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. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -634,12 +634,12 @@ Contains details about a gift card that has been added to a cart. "custom_attributes": [CustomAttribute], "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -653,11 +653,11 @@ Contains details about a gift card. | 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. | +| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example @@ -665,8 +665,8 @@ Contains details about a gift card. { "message": "abc123", "recipient_email": "abc123", - "recipient_name": "abc123", - "sender_email": "xyz789", + "recipient_name": "xyz789", + "sender_email": "abc123", "sender_name": "abc123" } ``` @@ -681,13 +681,13 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -695,11 +695,11 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "xyz789", + "message": "abc123", + "recipient_email": "abc123", + "recipient_name": "abc123", "sender_email": "xyz789", - "sender_name": "abc123" + "sender_name": "xyz789" } ``` @@ -711,21 +711,21 @@ Contains details about the sender, recipient, and amount of a gift card. | 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. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](types-k-p.md#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. | +| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#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. | @@ -733,8 +733,8 @@ Contains details about the sender, recipient, and amount of a gift card. | `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. | +| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -742,7 +742,7 @@ Contains details about the sender, recipient, and amount of a gift card. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_card": GiftCardItem, "gift_message": GiftMessage, @@ -750,15 +750,15 @@ Contains details about the sender, recipient, and amount of a gift card. "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "xyz789", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, + "product_type": "abc123", + "product_url_key": "abc123", + "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, "quantity_return_requested": 987.65, "quantity_returned": 987.65, "quantity_shipped": 987.65, @@ -777,56 +777,56 @@ Defines properties of a gift card. | 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. | +| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](types-a-b.md#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#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. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#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. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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. | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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 | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](types-q-s.md#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 @@ -834,31 +834,31 @@ Defines properties of a gift card. ```json { "allow_message": true, - "allow_open_amount": true, - "canonical_url": "abc123", + "allow_open_amount": false, + "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": true, - "gift_wrapping_available": false, + "gift_message_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", "image": ProductImage, "is_redeemable": false, - "is_returnable": "xyz789", - "lifetime": 987, - "manufacturer": 123, - "max_sale_qty": 123.45, + "is_returnable": "abc123", + "lifetime": 123, + "manufacturer": 987, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "message_max_length": 123, + "message_max_length": 987, "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", - "min_sale_qty": 987.65, + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "min_sale_qty": 123.45, "name": "abc123", "new_from_date": "abc123", "new_to_date": "xyz789", @@ -866,14 +866,14 @@ Defines properties of a gift card. "open_amount_max": 987.65, "open_amount_min": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_price": 123.45, "special_to_date": "xyz789", @@ -897,11 +897,11 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#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.)* | +| `product` - [`ProductInterface!`](types-k-p.md#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. | +| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | #### Example @@ -912,7 +912,7 @@ Contains details about gift cards added to a requisition list. "gift_card_options": GiftCardOptions, "product": ProductInterface, "quantity": 123.45, - "sku": "xyz789", + "sku": "abc123", "uid": 4 } ``` @@ -927,10 +927,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -938,12 +938,12 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "product_sku": "abc123", + "quantity_shipped": 123.45 } ``` @@ -977,12 +977,12 @@ A single gift card added to a wish list. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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.)* | +| `product` - [`ProductInterface!`](types-k-p.md#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 @@ -993,9 +993,9 @@ A single gift card added to a wish list. "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "gift_card_options": GiftCardOptions, - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1009,16 +1009,16 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | +| `from` - [`String!`](types-q-s.md#string) | Sender name | +| `message` - [`String!`](types-q-s.md#string) | Gift message text | +| `to` - [`String!`](types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "xyz789", - "message": "xyz789", + "from": "abc123", + "message": "abc123", "to": "xyz789" } ``` @@ -1033,17 +1033,17 @@ Defines a gift message. | 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. | +| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | #### Example ```json { "from": "xyz789", - "message": "xyz789", - "to": "abc123" + "message": "abc123", + "to": "xyz789" } ``` @@ -1057,12 +1057,12 @@ Contains prices for gift wrapping options. | 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. | +| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](types-k-p.md#money) | Price for the printed card including tax. | #### Example @@ -1087,15 +1087,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `event_name` - [`String!`](types-q-s.md#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. | +| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](types-q-s.md#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. | +| `shipping_address` - [`CustomerAddress`](types-c-e.md#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. | @@ -1104,18 +1104,18 @@ Contains details about a gift registry. ```json { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "xyz789", + "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" } ``` @@ -1129,8 +1129,8 @@ Contains details about a gift registry. |------------|-------------| | `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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example @@ -1138,7 +1138,7 @@ Contains details about a gift registry. { "code": "4", "group": "EVENT_INFORMATION", - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -1177,7 +1177,7 @@ Defines a dynamic attribute. | 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. | +| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example @@ -1194,8 +1194,8 @@ Defines a dynamic attribute. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1209,8 +1209,8 @@ Defines a dynamic attribute. ```json { "code": 4, - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -1222,11 +1222,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Example @@ -1234,11 +1234,11 @@ Defines a dynamic attribute. ```json { "attribute_group": "abc123", - "code": "4", - "input_type": "abc123", - "is_required": true, + "code": 4, + "input_type": "xyz789", + "is_required": false, "label": "abc123", - "sort_order": 987 + "sort_order": 123 } ``` @@ -1250,11 +1250,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](types-q-s.md#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. | +| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1267,11 +1267,11 @@ Defines a dynamic attribute. ```json { - "attribute_group": "xyz789", + "attribute_group": "abc123", "code": 4, - "input_type": "xyz789", + "input_type": "abc123", "is_required": true, - "label": "xyz789", + "label": "abc123", "sort_order": 123 } ``` @@ -1284,9 +1284,9 @@ Defines a dynamic attribute. | 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.)* | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface!`](types-k-p.md#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. | @@ -1296,11 +1296,11 @@ Defines a dynamic attribute. ```json { "created_at": "abc123", - "note": "abc123", + "note": "xyz789", "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 123.45, - "uid": 4 + "quantity": 987.65, + "quantity_fulfilled": 987.65, + "uid": "4" } ``` @@ -1312,9 +1312,9 @@ Defines a dynamic attribute. | 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.)* | +| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface!`](types-k-p.md#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. | @@ -1332,9 +1332,9 @@ Defines a dynamic attribute. "created_at": "abc123", "note": "xyz789", "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "quantity_fulfilled": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -1348,20 +1348,20 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](types-a-b.md#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) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example ```json { - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -1379,7 +1379,7 @@ Contains details about an error that occurred when processing a gift registry it | `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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1387,8 +1387,8 @@ Contains details about an error that occurred when processing a gift registry it ```json { "code": "OUT_OF_STOCK", - "gift_registry_item_uid": 4, - "gift_registry_uid": "4", + "gift_registry_item_uid": "4", + "gift_registry_uid": 4, "message": "abc123", "product_uid": "4" } @@ -1430,7 +1430,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1468,9 +1468,9 @@ Contains details about a registrant. | 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. | +| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1483,7 +1483,7 @@ Contains details about a registrant. "email": "xyz789", "firstname": "xyz789", "lastname": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1496,8 +1496,8 @@ Contains details about a registrant. | 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. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | #### Example @@ -1519,23 +1519,23 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | +| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](types-q-s.md#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. | +| `location` - [`String`](types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](types-q-s.md#string) | The type of event being held. | #### Example ```json { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "abc123", "gift_registry_uid": 4, "location": "abc123", "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ``` @@ -1549,7 +1549,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](types-c-e.md#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. | @@ -1559,7 +1559,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or { "address_data": CustomerAddressInput, "address_id": 4, - "customer_address_uid": 4 + "customer_address_uid": "4" } ``` @@ -1593,7 +1593,7 @@ Contains details about a gift registry type. | 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. | +| `label` - [`String!`](types-q-s.md#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 @@ -1604,7 +1604,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1618,19 +1618,19 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `design` - [`String!`](types-q-s.md#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. | +| `price` - [`Money!`](types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example ```json { - "design": "xyz789", + "design": "abc123", "image": GiftWrappingImage, "price": Money, - "uid": "4" + "uid": 4 } ``` @@ -1644,14 +1644,14 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | #### Example ```json { - "label": "abc123", + "label": "xyz789", "url": "abc123" } ``` @@ -1664,17 +1664,17 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](#string) | The button color | +| `color` - [`String`](types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | +| `type` - [`String`](types-q-s.md#string) | The button type | #### Example ```json { - "color": "abc123", + "color": "xyz789", "height": 987, - "type": "xyz789" + "type": "abc123" } ``` @@ -1687,26 +1687,26 @@ Points to an image associated with a gift wrapping option. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | | `google_pay_mode` - [`GooglePayMode`](#googlepaymode) | Google Pay mode | -| `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 | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": GooglePayButtonStyles, - "code": "abc123", + "code": "xyz789", "google_pay_mode": "TEST", - "is_visible": false, + "is_visible": true, "payment_intent": "abc123", - "payment_source": "xyz789", + "payment_source": "abc123", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", @@ -1724,9 +1724,9 @@ Google Pay inputs | 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 | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example @@ -1767,46 +1767,46 @@ Defines a grouped product, which consists of simple standalone products that are | 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. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#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. | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#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. | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#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. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#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. | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#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. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#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 | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](types-q-s.md#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 @@ -1815,12 +1815,12 @@ Defines a grouped product, which consists of simple standalone products that are { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", @@ -1829,30 +1829,30 @@ Defines a grouped product, which consists of simple standalone products that are "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "abc123", - "new_from_date": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "name": "xyz789", + "new_from_date": "xyz789", "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 987.65, - "special_to_date": "abc123", + "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "weight": 987.65 } ``` @@ -1868,14 +1868,14 @@ Contains information about an individual grouped product item. | 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.)* | +| `product` - [`ProductInterface!`](types-k-p.md#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, + "position": 123, "product": ProductInterface, "qty": 987.65 } @@ -1891,23 +1891,23 @@ A grouped product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#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.)* | +| `product` - [`ProductInterface!`](types-k-p.md#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", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1921,14 +1921,14 @@ Input to retrieve a guest order based on token. | Input Field | Description | |-------------|-------------| -| `reason` - [`String!`](#string) | Cancellation reason. | -| `token` - [`String!`](#string) | Order token. | +| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | +| `token` - [`String!`](types-q-s.md#string) | Order token. | #### Example ```json { - "reason": "xyz789", + "reason": "abc123", "token": "xyz789" } ``` @@ -1943,9 +1943,9 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `lastname` - [`String!`](#string) | Order billing address lastname. | -| `number` - [`String!`](#string) | Order number. | +| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | +| `lastname` - [`String!`](types-q-s.md#string) | Order billing address lastname. | +| `number` - [`String!`](types-q-s.md#string) | Order number. | #### Example @@ -1967,17 +1967,17 @@ An object that provides highlighted text for matched words | 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 | +| `attribute` - [`String!`](types-q-s.md#string) | The product attribute that contains a match for the search phrase | +| `matched_words` - [`[String]!`](types-q-s.md#string) | An array of strings | +| `value` - [`String!`](types-q-s.md#string) | The matched text, enclosed within emphasis tags | #### Example ```json { "attribute": "xyz789", - "matched_words": ["xyz789"], - "value": "xyz789" + "matched_words": ["abc123"], + "value": "abc123" } ``` @@ -1991,23 +1991,23 @@ Item note data that is added to the negotiable quote history object. | 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. | +| `created_at` - [`String!`](types-q-s.md#string) | Datetime of the note added. | +| `creator_name` - [`String!`](types-q-s.md#string) | Name of the creator. | +| `creator_type` - [`String!`](types-q-s.md#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. | +| `note` - [`String!`](types-q-s.md#string) | The note added by the creator for the item | +| `product_name` - [`String!`](types-q-s.md#string) | Name of the quote item product for which note has been added. | #### Example ```json { "created_at": "abc123", - "creator_name": "xyz789", + "creator_name": "abc123", "creator_type": "xyz789", - "item_id": 987, - "note": "abc123", - "product_name": "xyz789" + "item_id": 123, + "note": "xyz789", + "product_name": "abc123" } ``` @@ -2019,29 +2019,29 @@ Item note data that is added to the negotiable quote history object. | 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 | +| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "cc_vault_code": "xyz789", - "code": "abc123", - "is_vault_enabled": false, - "is_visible": true, + "code": "xyz789", + "is_vault_enabled": true, + "is_visible": false, "payment_intent": "xyz789", "payment_source": "xyz789", - "requires_card_details": true, + "requires_card_details": false, "sdk_params": [SDKParams], "sort_order": "abc123", "three_ds_mode": "OFF", @@ -2059,26 +2059,26 @@ Hosted Fields payment inputs | 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 | +| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | #### Example ```json { - "cardBin": "abc123", - "cardExpiryMonth": "xyz789", + "cardBin": "xyz789", + "cardExpiryMonth": "abc123", "cardExpiryYear": "abc123", "cardLast4": "xyz789", - "holderName": "xyz789", - "is_active_payment_token_enabler": false, + "holderName": "abc123", + "is_active_payment_token_enabler": true, "payment_source": "xyz789", "payments_order_id": "abc123", "paypal_order_id": "abc123" @@ -2094,7 +2094,7 @@ The `ID` scalar type represents a unique identifier, often used to refetch an ob #### Example ```json -"4" +4 ``` @@ -2105,8 +2105,8 @@ The `ID` scalar type represents a unique identifier, often used to refetch an ob | 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. | +| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -2127,8 +2127,8 @@ Result of importing a shared requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The imported requisition list for the current customer. | -| `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Validation or import issues. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The imported requisition list for the current customer. | +| `user_errors` - [`[ShareRequisitionListUserError]!`](types-q-s.md#sharerequisitionlistusererror) | Validation or import issues. | #### Example @@ -2169,8 +2169,8 @@ List of templates/filters applied to customer attribute input. | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `code` - [`CartUserInputErrorType!`](types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | | `quantity` - [`Float`](#float) | Amount of available stock | #### Example @@ -2192,7 +2192,7 @@ The `Int` scalar type represents non-fractional signed whole numeric values. Int #### Example ```json -987 +123 ``` @@ -2205,12 +2205,12 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -2223,11 +2223,11 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the invoice. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#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. | +| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2238,7 +2238,7 @@ Contains invoice details. "custom_attributes": [CustomAttribute], "id": "4", "items": [InvoiceItemInterface], - "number": "abc123", + "number": "xyz789", "total": InvoiceTotal } ``` @@ -2253,8 +2253,8 @@ Defines an invoice custom attributes. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for invoice. | -| `invoice_id` - [`String!`](#string) | The invoice ID. | +| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for invoice. | +| `invoice_id` - [`String!`](types-q-s.md#string) | The invoice ID. | #### Example @@ -2273,13 +2273,13 @@ Defines an invoice custom attributes. | 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. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2288,11 +2288,11 @@ Defines an invoice custom attributes. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 987.65 } ``` @@ -2307,9 +2307,9 @@ Defines an invoice item custom attributes. | 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. | +| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for invoice item. | +| `invoice_id` - [`String!`](types-q-s.md#string) | The invoice ID. | +| `invoice_item_id` - [`String!`](types-q-s.md#string) | The invoice item ID. | #### Example @@ -2331,21 +2331,21 @@ Contains detailes about invoiced items. | 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. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](types-c-e.md#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. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`BundleInvoiceItem`](#bundleinvoiceitem) | -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2355,11 +2355,11 @@ Contains detailes about invoiced items. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 123.45 } ``` @@ -2392,14 +2392,14 @@ Contains price details from an invoice. | 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. | +| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2426,7 +2426,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2444,12 +2444,12 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2462,12 +2462,12 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example ```json -{"is_role_name_available": true} +{"is_role_name_available": false} ``` @@ -2480,12 +2480,12 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2498,12 +2498,12 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2515,12 +2515,12 @@ Contains the result of the `isEmailAvailable` query. | Input Field | Description | |-------------|-------------| | `type` - [`IsOperatorType`](#isoperatortype) | | -| `value` - [`Boolean`](#boolean) | | +| `value` - [`Boolean`](types-a-b.md#boolean) | | #### Example ```json -{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true} +{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": false} ``` @@ -2548,13 +2548,13 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `isSubscribed` - [`Boolean!`](#boolean) | | -| `message` - [`String`](#string) | | +| `isSubscribed` - [`Boolean!`](types-a-b.md#boolean) | | +| `message` - [`String`](types-q-s.md#string) | | #### Example ```json -{"isSubscribed": true, "message": "xyz789"} +{"isSubscribed": false, "message": "xyz789"} ``` @@ -2567,23 +2567,23 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](types-q-s.md#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_name` - [`String`](types-q-s.md#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` - [`String`](types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example ```json { - "created_at": "abc123", + "created_at": "xyz789", "creator_id": 123, - "creator_name": "xyz789", + "creator_name": "abc123", "creator_type": 123, - "negotiable_quote_item_uid": "4", + "negotiable_quote_item_uid": 4, "note": "xyz789", "note_uid": "4" } @@ -2599,7 +2599,7 @@ A list of options of the selected bundle product. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The label of the option. | +| `label` - [`String!`](types-q-s.md#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. | @@ -2608,7 +2608,7 @@ A list of options of the selected bundle product. ```json { "label": "abc123", - "uid": 4, + "uid": "4", "values": [ItemSelectedBundleOptionValue] } ``` @@ -2623,9 +2623,9 @@ A list of values for the selected bundle product. | 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. | +| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](types-q-s.md#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. | @@ -2635,9 +2635,9 @@ A list of values for the selected bundle product. { "price": Money, "product_name": "abc123", - "product_sku": "xyz789", + "product_sku": "abc123", "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -2661,14 +2661,14 @@ A JSON scalar | 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 | +| `key` - [`String!`](types-q-s.md#string) | The unique key identifier from the upload | +| `media_resource_type` - [`MediaResourceType!`](types-k-p.md#mediaresourcetype) | The type of media resource being uploaded | #### Example ```json { - "key": "xyz789", + "key": "abc123", "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" } ``` @@ -2681,17 +2681,17 @@ A JSON scalar | 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 | +| `key` - [`String!`](types-q-s.md#string) | The unique key identifier | +| `message` - [`String`](types-q-s.md#string) | Additional information about the confirmation | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Whether the confirmation was successful | #### Example ```json { - "key": "abc123", + "key": "xyz789", "message": "abc123", - "success": false + "success": true } ``` @@ -2703,8 +2703,8 @@ A JSON scalar | 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 | +| `key` - [`String!`](types-q-s.md#string) | The name of the file to be uploaded, cannot contain slashes | +| `media_resource_type` - [`MediaResourceType!`](types-k-p.md#mediaresourcetype) | The type of media resource being uploaded | #### Example @@ -2723,16 +2723,16 @@ A JSON scalar | 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 | +| `expires_at` - [`String!`](types-q-s.md#string) | The expiration timestamp of the URL | +| `key` - [`String!`](types-q-s.md#string) | The unique key identifier for the upload | +| `upload_url` - [`String!`](types-q-s.md#string) | The presigned URL for uploading the file | #### Example ```json { - "expires_at": "xyz789", - "key": "xyz789", + "expires_at": "abc123", + "key": "abc123", "upload_url": "xyz789" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md index 67b1a20df..afae8dc51 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md @@ -8,8 +8,8 @@ Contains a key-value pair. | 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. | +| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | #### Example @@ -50,16 +50,16 @@ Sets quote item note. | 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. | +| `note` - [`String`](types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "note": "abc123", - "quote_item_uid": 4, + "quote_item_uid": "4", "quote_uid": 4 } ``` @@ -74,17 +74,17 @@ Contains basic information about a product image or video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Possible Types | MediaGalleryInterface Types | |----------------| -| [`AssetImage`](#assetimage) | -| [`AssetVideo`](#assetvideo) | +| [`AssetImage`](types-a-b.md#assetimage) | +| [`AssetVideo`](types-a-b.md#assetvideo) | | [`ProductImage`](#productimage) | | [`ProductVideo`](#productvideo) | @@ -93,9 +93,9 @@ Contains basic information about a product image or video. ```json { "disabled": true, - "label": "abc123", + "label": "xyz789", "position": 123, - "url": "abc123" + "url": "xyz789" } ``` @@ -129,12 +129,12 @@ Enumeration of media resource types | Field Name | Description | |------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{"type": "abc123"} +{"type": "xyz789"} ``` @@ -145,14 +145,14 @@ Enumeration of media resource types | Field Name | Description | |------------|-------------| -| `layout` - [`String`](#string) | The message layout | +| `layout` - [`String`](types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "layout": "xyz789", + "layout": "abc123", "logo": MessageStyleLogo } ``` @@ -167,8 +167,8 @@ Defines a monetary value, including a numeric value and a currency code. | 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. | +| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | #### Example @@ -186,9 +186,9 @@ Contains the customer's gift registry and any errors encountered. | 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. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -210,7 +210,7 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example @@ -228,8 +228,8 @@ Output of the request to move items to another requisition list. | 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. | +| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -250,17 +250,17 @@ Move Line Item to Requisition List. | 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. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json { - "quote_item_uid": 4, - "quote_uid": "4", - "requisition_list_uid": 4 + "quote_item_uid": "4", + "quote_uid": 4, + "requisition_list_uid": "4" } ``` @@ -292,9 +292,9 @@ Contains the source and target wish lists after moving products. | 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. | +| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -316,29 +316,29 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the negotiable quote | +| `email` - [`String`](types-q-s.md#string) | The email address of the company user. | +| `expiration_date` - [`String!`](types-q-s.md#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. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | +| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The order created from the negotiable quote. | +| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | +| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#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. | +| `template_id` - [`ID`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_name` - [`String`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -351,22 +351,22 @@ Contains details about a negotiable quote. "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "order": CustomerOrder, "prices": CartPrices, "sales_rep_name": "xyz789", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", - "template_id": 4, + "template_id": "4", "template_name": "xyz789", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -380,15 +380,15 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | +| `code` - [`String!`](types-q-s.md#string) | The address country code. | +| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | #### Example ```json { - "code": "xyz789", - "label": "abc123" + "code": "abc123", + "label": "xyz789" } ``` @@ -402,45 +402,45 @@ Defines the billing or shipping address to be applied to the cart. | 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). | +| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping negotiable quote address. | +| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", - "country_code": "xyz789", + "country_code": "abc123", "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "xyz789", + "fax": "xyz789", + "firstname": "abc123", "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", - "region": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", + "region": "xyz789", "region_id": 987, - "save_in_address_book": true, - "street": ["xyz789"], + "save_in_address_book": false, + "street": ["abc123"], "suffix": "xyz789", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -452,23 +452,23 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Possible Types @@ -482,22 +482,22 @@ Defines the billing or shipping address to be applied to the cart. ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", - "fax": "abc123", + "customer_address_uid": 4, + "fax": "xyz789", "firstname": "abc123", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", - "telephone": "abc123", + "telephone": "xyz789", "uid": "4", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -511,15 +511,15 @@ Defines the company's state or province. | 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. | +| `code` - [`String`](types-q-s.md#string) | The address region code. | +| `label` - [`String`](types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "abc123", "region_id": 987 } @@ -533,45 +533,45 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", - "fax": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", + "fax": "abc123", + "firstname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, - "vat_id": "abc123" + "suffix": "abc123", + "telephone": "abc123", + "uid": "4", + "vat_id": "xyz789" } ``` @@ -586,9 +586,9 @@ Defines the billing address. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example @@ -596,8 +596,8 @@ Defines the billing address. { "address": NegotiableQuoteAddressInput, "customer_address_uid": 4, - "same_as_shipping": false, - "use_for_shipping": true + "same_as_shipping": true, + "use_for_shipping": false } ``` @@ -613,10 +613,10 @@ Contains a single plain text comment from either the buyer or seller. |------------|-------------| | `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. | +| `created_at` - [`String!`](types-q-s.md#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. | +| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example @@ -624,10 +624,10 @@ Contains a single plain text comment from either the buyer or seller. { "attachments": [NegotiableQuoteCommentAttachment], "author": NegotiableQuoteUser, - "created_at": "abc123", + "created_at": "xyz789", "creator_type": "BUYER", "text": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -641,14 +641,14 @@ Negotiable quote comment file attachment. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | Negotiable quote comment attachment file name. | -| `url` - [`String!`](#string) | Negotiable quote comment attachment file url. | +| `name` - [`String!`](types-q-s.md#string) | Negotiable quote comment attachment file name. | +| `url` - [`String!`](types-q-s.md#string) | Negotiable quote comment attachment file url. | #### Example ```json { - "name": "xyz789", + "name": "abc123", "url": "xyz789" } ``` @@ -663,7 +663,7 @@ Negotiable quote comment file attachment. | Input Field | Description | |-------------|-------------| -| `key` - [`String!`](#string) | Negotiable quote comment attachment file key. | +| `key` - [`String!`](types-q-s.md#string) | Negotiable quote comment attachment file key. | #### Example @@ -699,7 +699,7 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| | `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](#negotiablequotecommentattachmentinput) | Negotiable quote comment file attachments. | -| `comment` - [`String!`](#string) | The comment provided by the buyer. | +| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | #### Example @@ -720,17 +720,17 @@ Contains custom log entries added by third-party extensions. | 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. | +| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { "new_value": "abc123", - "old_value": "abc123", - "title": "xyz789" + "old_value": "xyz789", + "title": "abc123" } ``` @@ -744,8 +744,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -796,12 +796,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "abc123"} +{"comment": "xyz789"} ``` @@ -817,9 +817,9 @@ Contains details about a change for a negotiable quote. | `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. | +| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `item_note` - [`HistoryItemNoteData`](types-f-i.md#historyitemnotedata) | Item note data that is added to the negotiable quote history object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -830,7 +830,7 @@ Contains details about a change for a negotiable quote. "changes": NegotiableQuoteHistoryChanges, "created_at": "abc123", "item_note": HistoryItemNoteData, - "uid": 4 + "uid": "4" } ``` @@ -863,15 +863,15 @@ Contains a new expiration date and the previous date. | 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. | +| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { "new_expiration": "abc123", - "old_expiration": "xyz789" + "old_expiration": "abc123" } ``` @@ -885,7 +885,7 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#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 @@ -966,12 +966,12 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -984,8 +984,8 @@ Specifies the updated quantity of an item. | 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. | +| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example @@ -1003,15 +1003,15 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "code": "abc123", - "purchase_order_number": "abc123" + "code": "xyz789", + "purchase_order_number": "xyz789" } ``` @@ -1025,10 +1025,10 @@ Contains a reference document link for a negotiable quote template. | 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. | +| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID!`](types-f-i.md#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | #### Example @@ -1049,49 +1049,49 @@ Contains a reference document link for a negotiable quote template. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](types-q-s.md#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. | +| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#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). | +| `selected_shipping_method` - [`SelectedShippingMethod`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "available_shipping_methods": [AvailableShippingMethod], - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", "uid": 4, - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -1106,16 +1106,16 @@ Defines shipping addresses for the negotiable quote. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "xyz789" + "customer_address_uid": "4", + "customer_notes": "abc123" } ``` @@ -1129,7 +1129,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1192,26 +1192,26 @@ Contains details about a negotiable quote template. |------------|-------------| | `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. | +| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was created. | +| `expiration_date` - [`String!`](types-q-s.md#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. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](types-c-e.md#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. | +| `sales_rep_name` - [`String!`](types-q-s.md#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. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `updated_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was updated. | #### Example @@ -1219,16 +1219,16 @@ Contains details about a negotiable quote template. { "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_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1237,7 +1237,7 @@ Contains details about a negotiable quote template. "sales_rep_name": "xyz789", "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "xyz789", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45, "uid": 4, "updated_at": "xyz789" @@ -1254,8 +1254,8 @@ Defines a filter to limit the negotiable quotes to return. | 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. | +| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1276,26 +1276,26 @@ Contains data for a negotiable quote template in a grid. | 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. | +| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | +| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was created. | +| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_ordered_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the last negotiable quote template order was placed. | +| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `updated_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was updated. | #### Example @@ -1305,22 +1305,22 @@ Contains data for a negotiable quote template in a grid. "company_name": "xyz789", "created_at": "abc123", "expiration_date": "abc123", - "is_min_max_qty_used": false, - "last_ordered_at": "xyz789", - "last_shared_at": "xyz789", + "is_min_max_qty_used": true, + "last_ordered_at": "abc123", + "last_shared_at": "abc123", "max_order_commitment": 987, "min_negotiated_grand_total": 123.45, "min_order_commitment": 987, "name": "abc123", - "orders_placed": 123, + "orders_placed": 987, "prices": CartPrices, - "sales_rep_name": "abc123", - "state": "abc123", + "sales_rep_name": "xyz789", + "state": "xyz789", "status": "abc123", "submitted_by": "xyz789", "template_id": "4", "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -1367,8 +1367,8 @@ Contains details about a change for a negotiable quote template. | `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. | +| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -1377,8 +1377,8 @@ Contains details about a change for a negotiable quote template. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteTemplateHistoryChanges, - "created_at": "xyz789", - "uid": 4 + "created_at": "abc123", + "uid": "4" } ``` @@ -1392,15 +1392,15 @@ Lists a new status change applied to a negotiable quote template and the previou | 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. | +| `new_status` - [`String!`](types-q-s.md#string) | The updated status. | +| `old_status` - [`String`](types-q-s.md#string) | The previous status. The value will be null for the first history entry in a negotiable quote. | #### Example ```json { - "new_status": "abc123", - "old_status": "abc123" + "new_status": "xyz789", + "old_status": "xyz789" } ``` @@ -1432,15 +1432,15 @@ Specifies the updated quantity of an 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. | +| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | #### Example ```json -{"item_id": 4, "max_qty": 123.45, "min_qty": 987.65, "quantity": 987.65} +{"item_id": 4, "max_qty": 987.65, "min_qty": 123.45, "quantity": 987.65} ``` @@ -1453,18 +1453,18 @@ Defines the reference document link to add to a negotiable quote template. | 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. | +| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | #### Example ```json { "document_identifier": "abc123", - "document_name": "abc123", - "link_id": "4", + "document_name": "xyz789", + "link_id": 4, "reference_document_url": "abc123" } ``` @@ -1480,8 +1480,8 @@ Defines shipping addresses for the negotiable quote template. | 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. | +| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | #### Example @@ -1489,7 +1489,7 @@ Defines shipping addresses for the negotiable quote template. { "address": NegotiableQuoteAddressInput, "customer_address_uid": 4, - "customer_notes": "xyz789" + "customer_notes": "abc123" } ``` @@ -1503,7 +1503,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1540,9 +1540,9 @@ Contains a list of negotiable templates that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1563,7 +1563,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1574,7 +1574,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -1587,12 +1587,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -1605,14 +1605,14 @@ A limited view of a Buyer or Seller in the negotiable quote process. | 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. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | #### Example ```json { - "firstname": "abc123", + "firstname": "xyz789", "lastname": "abc123" } ``` @@ -1628,9 +1628,9 @@ Contains a list of negotiable that match the specified filter. | 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 | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1639,7 +1639,7 @@ Contains a list of negotiable that match the specified filter. "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } ``` @@ -1653,13 +1653,16 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json -{"message": "xyz789", "uid": 4} +{ + "message": "abc123", + "uid": "4" +} ``` @@ -1707,8 +1710,8 @@ A custom fee applied to the cart by an out-of-process webhook. | Field Name | Description | |------------|-------------| | `amount` - [`Money!`](#money) | The fee amount in the cart currency. | -| `code` - [`String!`](#string) | The unique identifier for this fee. | -| `label` - [`String!`](#string) | The display label for this fee. | +| `code` - [`String!`](types-q-s.md#string) | The unique identifier for this fee. | +| `label` - [`String!`](types-q-s.md#string) | The display label for this fee. | #### Example @@ -1728,14 +1731,14 @@ A custom fee applied to the cart by an out-of-process webhook. | 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. | +| `backend_integration_url` - [`String!`](types-q-s.md#string) | The backend URL to dispatch requests related to the payment method. | +| `custom_config` - [`[CustomConfigKeyValue]!`](types-c-e.md#customconfigkeyvalue) | Custom config key values. | #### Example ```json { - "backend_integration_url": "abc123", + "backend_integration_url": "xyz789", "custom_config": [CustomConfigKeyValue] } ``` @@ -1750,7 +1753,7 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -1766,11 +1769,11 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `rangeOperator` - [`RangeOperatorInput`](#rangeoperatorinput) | | -| `customOperator` - [`CustomOperatorInput`](#customoperatorinput) | | -| `isOperator` - [`IsOperatorInput`](#isoperatorinput) | | +| `rangeOperator` - [`RangeOperatorInput`](types-q-s.md#rangeoperatorinput) | | +| `customOperator` - [`CustomOperatorInput`](types-c-e.md#customoperatorinput) | | +| `isOperator` - [`IsOperatorInput`](types-f-i.md#isoperatorinput) | | | `numericOperator` - [`NumericOperatorInput`](#numericoperatorinput) | | -| `stringOperator` - [`StringOperatorInput`](#stringoperatorinput) | | +| `stringOperator` - [`StringOperatorInput`](types-q-s.md#stringoperatorinput) | | #### Example @@ -1794,12 +1797,12 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | +| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json -{"order_number": "xyz789"} +{"order_number": "abc123"} ``` @@ -1832,22 +1835,22 @@ Contains detailed information about an order's billing and shipping addresses. | 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). | +| `city` - [`String!`](types-q-s.md#string) | The city or town. | +| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example @@ -1858,14 +1861,14 @@ Contains detailed information about an order's billing and shipping addresses. "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "xyz789", "middlename": "abc123", - "postcode": "abc123", - "prefix": "abc123", - "region": "xyz789", + "postcode": "xyz789", + "prefix": "xyz789", + "region": "abc123", "region_id": "4", - "street": ["abc123"], + "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", "vat_id": "xyz789" @@ -1880,11 +1883,11 @@ Contains detailed information about an order's billing and shipping addresses. | 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 | +| `firstname` - [`String!`](types-q-s.md#string) | First name of the customer | +| `lastname` - [`String`](types-q-s.md#string) | Last name of the customer | +| `middlename` - [`String`](types-q-s.md#string) | Middle name of the customer | +| `prefix` - [`String`](types-q-s.md#string) | Prefix of the customer | +| `suffix` - [`String`](types-q-s.md#string) | Suffix of the customer | #### Example @@ -1894,7 +1897,7 @@ Contains detailed information about an order's billing and shipping addresses. "lastname": "xyz789", "middlename": "abc123", "prefix": "xyz789", - "suffix": "abc123" + "suffix": "xyz789" } ``` @@ -1906,29 +1909,29 @@ Contains detailed information about an order's billing and shipping addresses. | 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. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Example @@ -1936,27 +1939,27 @@ Contains detailed information about an order's billing and shipping addresses. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "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_return_requested": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -1970,38 +1973,38 @@ Order item details. | 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. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](types-a-b.md#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. | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](types-f-i.md#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_name` - [`String`](types-q-s.md#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. | +| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](types-f-i.md#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. | +| `status` - [`String`](types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`BundleOrderItem`](#bundleorderitem) | -| [`ConfigurableOrderItem`](#configurableorderitem) | -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | +| [`ConfigurableOrderItem`](types-c-e.md#configurableorderitem) | +| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | +| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -2022,12 +2025,12 @@ Order item details. "product_sku": "xyz789", "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 987.65, + "quantity_canceled": 123.45, "quantity_invoiced": 987.65, "quantity_ordered": 123.45, "quantity_refunded": 123.45, "quantity_return_requested": 987.65, - "quantity_returned": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" @@ -2044,8 +2047,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | +| `label` - [`String!`](types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](types-q-s.md#string) | The value of the option. | #### Example @@ -2064,8 +2067,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](types-f-i.md#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. | @@ -2105,8 +2108,8 @@ Contains details about the payment method used to pay for the order. | 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. | +| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example @@ -2114,7 +2117,7 @@ Contains details about the payment method used to pay for the order. { "additional_data": [KeyValue], "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ``` @@ -2128,11 +2131,11 @@ Contains order shipment details. | 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. | +| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example @@ -2156,7 +2159,7 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](#string) | Order token. | +| `token` - [`String!`](types-q-s.md#string) | Order token. | #### Example @@ -2175,14 +2178,14 @@ Contains details about the sales total amounts used to calculate the final price | 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) | | +| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#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. | +| `shipping_handling` - [`ShippingHandling`](types-q-s.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#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. | @@ -2243,15 +2246,15 @@ Defines the payment attribute. | Input Field | Description | |-------------|-------------| -| `key` - [`String!`](#string) | The code of the attribute. | -| `value` - [`String!`](#string) | The value of the attribute. | +| `key` - [`String!`](types-q-s.md#string) | The code of the attribute. | +| `value` - [`String!`](types-q-s.md#string) | The value of the attribute. | #### Example ```json { - "key": "xyz789", - "value": "abc123" + "key": "abc123", + "value": "xyz789" } ``` @@ -2265,29 +2268,29 @@ Contains payment fields that are common to all types of payment methods. | 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 | +| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`ApplePayConfig`](#applepayconfig) | -| [`FastlaneConfig`](#fastlaneconfig) | -| [`GooglePayConfig`](#googlepayconfig) | -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | +| [`ApplePayConfig`](types-a-b.md#applepayconfig) | +| [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | +| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | +| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | #### Example ```json { "code": "abc123", - "is_visible": false, + "is_visible": true, "payment_intent": "abc123", "sdk_params": [SDKParams], "sort_order": "xyz789", @@ -2305,11 +2308,11 @@ Retrieves the payment configuration for a given location | 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 | +| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `fastlane` - [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | Fastlane payment method configuration | +| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2357,21 +2360,21 @@ Defines the payment method. | 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. | +| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](types-f-i.md#fastlanemethodinput) | Required input for fastlane | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#vaultmethodinput) | Required input for vault | +| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { "additional_data": [PaymentAttributeInput], - "code": "abc123", + "code": "xyz789", "payment_services_paypal_apple_pay": ApplePayMethodInput, "payment_services_paypal_fastlane": FastlaneMethodInput, "payment_services_paypal_google_pay": GooglePayMethodInput, @@ -2392,10 +2395,10 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](types-q-s.md#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 | +| `status` - [`String`](types-q-s.md#string) | The status of the payment order | #### Example @@ -2416,8 +2419,8 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | +| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | #### Example @@ -2436,7 +2439,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | +| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2454,7 +2457,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | +| `card` - [`CardPaymentSourceInput!`](types-c-e.md#cardpaymentsourceinput) | The card payment source information | #### Example @@ -2472,7 +2475,7 @@ The payment source information | Field Name | Description | |------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | +| `card` - [`CardPaymentSourceOutput!`](types-c-e.md#cardpaymentsourceoutput) | The card payment source information | #### Example @@ -2490,18 +2493,18 @@ The stored payment method available to the customer. | 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. | +| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "details": "xyz789", + "details": "abc123", "payment_method_code": "abc123", - "public_hash": "xyz789", + "public_hash": "abc123", "type": "card" } ``` @@ -2535,22 +2538,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](types-f-i.md#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) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | #### Example ```json -{"weight": 987.65} +{"weight": 123.45} ``` @@ -2563,39 +2566,39 @@ Defines Pickup Location information. | 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) | | +| `city` - [`String`](types-q-s.md#string) | | +| `contact_name` - [`String`](types-q-s.md#string) | | +| `country_id` - [`String`](types-q-s.md#string) | | +| `description` - [`String`](types-q-s.md#string) | | +| `email` - [`String`](types-q-s.md#string) | | +| `fax` - [`String`](types-q-s.md#string) | | +| `latitude` - [`Float`](types-f-i.md#float) | | +| `longitude` - [`Float`](types-f-i.md#float) | | +| `name` - [`String`](types-q-s.md#string) | | +| `phone` - [`String`](types-q-s.md#string) | | +| `pickup_location_code` - [`String`](types-q-s.md#string) | | +| `postcode` - [`String`](types-q-s.md#string) | | +| `region` - [`String`](types-q-s.md#string) | | +| `region_id` - [`Int`](types-f-i.md#int) | | +| `street` - [`String`](types-q-s.md#string) | | #### Example ```json { "city": "xyz789", - "contact_name": "xyz789", + "contact_name": "abc123", "country_id": "xyz789", - "description": "abc123", + "description": "xyz789", "email": "xyz789", - "fax": "xyz789", + "fax": "abc123", "latitude": 987.65, - "longitude": 123.45, + "longitude": 987.65, "name": "abc123", "phone": "abc123", "pickup_location_code": "abc123", "postcode": "xyz789", - "region": "abc123", + "region": "xyz789", "region_id": 987, "street": "xyz789" } @@ -2611,14 +2614,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | 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. | +| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2645,22 +2648,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | 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. | +| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2696,8 +2699,8 @@ Top level object returned in a pickup locations search. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | #### Example @@ -2719,7 +2722,7 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2756,7 +2759,7 @@ An output object that returns the generated order. | Field Name | Description | |------------|-------------| | `errors` - [`[PlaceOrderError]`](#placeordererror) | An array of place negotiable quote order errors. | -| `order` - [`CustomerOrder`](#customerorder) | Full order information. | +| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | #### Example @@ -2778,7 +2781,7 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example @@ -2819,12 +2822,12 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json -{"purchase_order_uid": 4} +{"purchase_order_uid": "4"} ``` @@ -2837,7 +2840,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | #### Example @@ -2855,7 +2858,7 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2874,7 +2877,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| | `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | -| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | +| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | #### Example @@ -2895,12 +2898,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -2953,13 +2956,13 @@ Specifies the amount and type of price adjustment. | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](#float) | The amount of the price adjustment. | -| `code` - [`String`](#string) | Identifies the type of price adjustment. | +| `amount` - [`Float`](types-f-i.md#float) | The amount of the price adjustment. | +| `code` - [`String`](types-q-s.md#string) | Identifies the type of price adjustment. | #### Example ```json -{"amount": 123.45, "code": "abc123"} +{"amount": 123.45, "code": "xyz789"} ``` @@ -2972,9 +2975,9 @@ Can be used to retrieve the main price details in case of bundle product | 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 | +| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | #### Example @@ -3055,7 +3058,7 @@ Defines whether a bundle product's price is displayed as the lowest possible val | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | | +| `sku` - [`String!`](types-q-s.md#string) | | #### Example @@ -3071,7 +3074,7 @@ Defines whether a bundle product's price is displayed as the lowest possible val | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | | +| `sku` - [`String!`](types-q-s.md#string) | | #### Example @@ -3087,13 +3090,13 @@ Defines whether a bundle product's price is displayed as the lowest possible val | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | | -| `success` - [`Boolean!`](#boolean) | | +| `message` - [`String`](types-q-s.md#string) | | +| `success` - [`Boolean!`](types-a-b.md#boolean) | | #### Example ```json -{"message": "xyz789", "success": true} +{"message": "abc123", "success": true} ``` @@ -3106,8 +3109,8 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | +| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | #### Example @@ -3126,17 +3129,17 @@ Contains a product attribute code and value. | 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. | +| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `url` - [`String!`](types-q-s.md#string) | Public URL to download the file. | +| `value` - [`String!`](types-q-s.md#string) | Stored filename only (e.g. file_xyz.pdf). Use url for download. | #### Example ```json { - "attribute_type": "abc123", - "code": 4, + "attribute_type": "xyz789", + "code": "4", "url": "xyz789", "value": "abc123" } @@ -3152,8 +3155,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3174,13 +3177,13 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | #### Example ```json -{"amount_off": 123.45, "percent_off": 123.45} +{"amount_off": 123.45, "percent_off": 987.65} ``` @@ -3193,19 +3196,19 @@ Contains product image information, including the image URL and label. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { - "disabled": false, - "label": "abc123", + "disabled": true, + "label": "xyz789", "position": 123, - "url": "abc123" + "url": "xyz789" } ``` @@ -3236,7 +3239,7 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | +| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | #### Example @@ -3254,57 +3257,57 @@ Contains fields that are common to all types of products. | 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. | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](types-q-s.md#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. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#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 | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](types-f-i.md#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. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](types-q-s.md#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. | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | +| `quantity` - [`Float`](types-f-i.md#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. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#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. | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#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. | +| `swatch_image` - [`String`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#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 | +| `url_key` - [`String`](types-q-s.md#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) | +| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | +| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`VirtualProduct`](types-t-z.md#virtualproduct) | #### Example @@ -3312,23 +3315,23 @@ Contains fields that are common to all types of products. { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 123, - "max_sale_qty": 987.65, + "manufacturer": 987, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "abc123", + "meta_description": "xyz789", + "meta_keyword": "xyz789", "meta_title": "abc123", "min_sale_qty": 123.45, - "name": "xyz789", + "name": "abc123", "new_from_date": "xyz789", "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, @@ -3339,14 +3342,14 @@ Contains fields that are common to all types of products. "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, - "special_to_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "abc123" } @@ -3362,11 +3365,11 @@ An implementation of `ProductLinksInterface`. | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Example @@ -3374,7 +3377,7 @@ An implementation of `ProductLinksInterface`. { "link_type": "xyz789", "linked_product_sku": "abc123", - "linked_product_type": "abc123", + "linked_product_type": "xyz789", "position": 987, "sku": "abc123" } @@ -3390,11 +3393,11 @@ Contains information about linked products, including the link type and product | 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. | +| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3406,10 +3409,10 @@ Contains information about linked products, including the link type and product ```json { - "link_type": "abc123", + "link_type": "xyz789", "linked_product_sku": "abc123", - "linked_product_type": "abc123", - "position": 123, + "linked_product_type": "xyz789", + "position": 987, "sku": "abc123" } ``` @@ -3424,17 +3427,17 @@ Contains basic information about the image asset. | Field Name | Description | |------------|-------------| -| `asset_id` - [`String`](#string) | Asset Id. | -| `media_type` - [`String`](#string) | Must be asset-image. | -| `media_url` - [`String`](#string) | Asset Image Url. | +| `asset_id` - [`String`](types-q-s.md#string) | Asset Id. | +| `media_type` - [`String`](types-q-s.md#string) | Must be asset-image. | +| `media_url` - [`String`](types-q-s.md#string) | Asset Image Url. | #### Example ```json { "asset_id": "xyz789", - "media_type": "xyz789", - "media_url": "abc123" + "media_type": "abc123", + "media_url": "xyz789" } ``` @@ -3448,17 +3451,17 @@ Contains basic information about the video asset. | 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. | +| `media_type` - [`String`](types-q-s.md#string) | Must be asset-video. | +| `video_asset_id` - [`String`](types-q-s.md#string) | Asset Id. | +| `video_media_url` - [`String`](types-q-s.md#string) | Asset Video Url. | #### Example ```json { - "media_type": "abc123", + "media_type": "xyz789", "video_asset_id": "abc123", - "video_media_url": "xyz789" + "video_media_url": "abc123" } ``` @@ -3472,19 +3475,19 @@ Contains a link to a video file and basic information about the video. | 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. | +| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | #### Example ```json { "media_type": "abc123", - "video_description": "xyz789", + "video_description": "abc123", "video_metadata": "xyz789", "video_provider": "xyz789", "video_title": "xyz789", @@ -3504,7 +3507,7 @@ Represents a product price. |------------|-------------| | `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. | +| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#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 @@ -3528,8 +3531,8 @@ A single product returned by the query | Field Name | 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 | +| `applied_query_rule` - [`AppliedQueryRule`](types-a-b.md#appliedqueryrule) | The query rule type that was applied to this product, if any (in preview mode only, returns null otherwise) | +| `highlights` - [`[Highlight]`](types-f-i.md#highlight) | An object that provides highlighted text for matched words | | `productView` - [`ProductView`](#productview) | Contains a product view | #### Example @@ -3552,12 +3555,12 @@ Contains the output of a `productSearch` query | Field Name | Description | |------------|-------------| -| `facets` - [`[Aggregation]`](#aggregation) | Details about the static and dynamic facets relevant to the search | +| `facets` - [`[Aggregation]`](types-a-b.md#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 | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Information for rendering pages of search results | +| `related_terms` - [`[String]`](types-q-s.md#string) | An array of strings that might include merchant-defined synonyms | +| `suggestions` - [`[String]`](types-q-s.md#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`](types-f-i.md#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 @@ -3584,13 +3587,13 @@ The product attribute to sort on | Input Field | Description | |-------------|-------------| -| `attribute` - [`String!`](#string) | The attribute code of a product attribute | -| `direction` - [`SortEnum!`](#sortenum) | ASC (ascending) or DESC (descending) | +| `attribute` - [`String!`](types-q-s.md#string) | The attribute code of a product attribute | +| `direction` - [`SortEnum!`](types-q-s.md#sortenum) | ASC (ascending) or DESC (descending) | #### Example ```json -{"attribute": "xyz789", "direction": "ASC"} +{"attribute": "abc123", "direction": "ASC"} ``` @@ -3603,15 +3606,15 @@ Structured warning with code and message for easier client handling | 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 | +| `code` - [`String!`](types-q-s.md#string) | Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH) | +| `message` - [`String!`](types-q-s.md#string) | Human-readable message describing the warning | #### Example ```json { "code": "xyz789", - "message": "abc123" + "message": "xyz789" } ``` @@ -3644,10 +3647,10 @@ Contains information about a product video. | 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. | +| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example @@ -3672,61 +3675,61 @@ Defines the product fields available to the SimpleProductView and ComplexProduct | 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.)* | +| `addToCartAllowed` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](types-a-b.md#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. | +| `description` - [`String`](types-q-s.md#string) | The detailed description of the product. | +| `id` - [`ID!`](types-f-i.md#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. | +| `lastModifiedAt` - [`DateTime`](types-c-e.md#datetime) | Date and time when the product was last updated. | +| `metaDescription` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings. | +| `metaKeyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `metaTitle` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](types-q-s.md#string) | Product title for search results listings. | +| `shortDescription` - [`String`](types-q-s.md#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. | +| `sku` - [`String`](types-q-s.md#string) | A unique code used for identification of a product. | +| `externalId` - [`String`](types-q-s.md#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | +| `url` - [`String`](types-q-s.md#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | +| `urlKey` - [`String`](types-q-s.md#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 | +| `queryType` - [`String`](types-q-s.md#string) | Indicates if the product was retrieved from the primary or the backup query | +| `visibility` - [`String`](types-q-s.md#string) | Visibility setting of the product | #### Possible Types | ProductView Types | |----------------| -| [`ComplexProductView`](#complexproductview) | -| [`SimpleProductView`](#simpleproductview) | +| [`ComplexProductView`](types-c-e.md#complexproductview) | +| [`SimpleProductView`](types-q-s.md#simpleproductview) | #### Example ```json { - "addToCartAllowed": false, + "addToCartAllowed": true, "inStock": false, - "lowStock": false, + "lowStock": true, "attributes": [ProductViewAttribute], - "description": "xyz789", + "description": "abc123", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", + "metaDescription": "xyz789", "metaKeyword": "xyz789", "metaTitle": "abc123", "name": "abc123", - "shortDescription": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "xyz789", + "sku": "abc123", "externalId": "abc123", "url": "xyz789", - "urlKey": "abc123", + "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "xyz789", + "queryType": "abc123", "visibility": "xyz789" } ``` @@ -3741,10 +3744,10 @@ A container for customer-defined attributes that are displayed the storefront. | Field Name | 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` | +| `label` - [`String`](types-q-s.md#string) | Label of the attribute. | +| `name` - [`String!`](types-q-s.md#string) | Name of an attribute code. For example, `color`, `size` or `material` | +| `roles` - [`[String]`](types-q-s.md#string) | Roles designated for an attribute on the storefront. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | +| `value` - [`JSON`](types-f-i.md#json) | Attribute value, arbitrary of type. For example, `red`, `blue` or `green` | #### Example @@ -3752,7 +3755,7 @@ A container for customer-defined attributes that are displayed the storefront. { "label": "xyz789", "name": "xyz789", - "roles": ["xyz789"], + "roles": ["abc123"], "value": {} } ``` @@ -3954,16 +3957,16 @@ Contains details about a product image. | 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`. | +| `label` - [`String`](types-q-s.md#string) | The display label of the product image. For example, `Main Image`, `Small Image` or `Thumbnail Image` | +| `roles` - [`[String]`](types-q-s.md#string) | A list that describes how the image is used. Can be `image`, `small_image` or `thumbnail` | +| `url` - [`String!`](types-q-s.md#string) | The URL to the product image. For example, `https://example.com/image.jpg`. | #### Example ```json { - "label": "abc123", - "roles": ["xyz789"], + "label": "xyz789", + "roles": ["abc123"], "url": "abc123" } ``` @@ -3978,31 +3981,31 @@ Product options provide a way to configure products by making selections of part | 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. | +| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this input option is required. | +| `type` - [`String`](types-q-s.md#string) | The type of data entry. For example, `text`, `number` or `date` | +| `markupAmount` - [`Float`](types-f-i.md#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`](types-q-s.md#string) | SKU suffix to add to the product. For example, `-red`, `-blue` or `-green` | +| `sortOrder` - [`Int`](types-f-i.md#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` | +| `fileExtensions` - [`String`](types-q-s.md#string) | The file extensions allowed for the image. For example, `jpg`, `png`, `gif`, or `svg` | #### Example ```json { - "id": "4", - "title": "xyz789", + "id": 4, + "title": "abc123", "required": false, "type": "abc123", - "markupAmount": 123.45, - "suffix": "xyz789", - "sortOrder": 123, + "markupAmount": 987.65, + "suffix": "abc123", + "sortOrder": 987, "range": ProductViewInputOptionRange, "imageSize": ProductViewInputOptionImageSize, - "fileExtensions": "xyz789" + "fileExtensions": "abc123" } ``` @@ -4016,13 +4019,13 @@ Dimensions of the image associated with the input option. | 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. | +| `width` - [`Int`](types-f-i.md#int) | The width of the image in pixels. For example, `100` for a 100px width. | +| `height` - [`Int`](types-f-i.md#int) | The height of the image, in pixels. For example, `100` for a 100px height. | #### Example ```json -{"width": 123, "height": 987} +{"width": 123, "height": 123} ``` @@ -4035,13 +4038,13 @@ Lists the value range associated with a `ProductViewInputOption`. For example, i | 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. | +| `from` - [`Float`](types-f-i.md#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`](types-f-i.md#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 -{"from": 987.65, "to": 987.65} +{"from": 987.65, "to": 123.45} ``` @@ -4055,14 +4058,14 @@ The product link type. Contains details about product links for related products | 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. | +| `linkTypes` - [`[String!]!`](types-q-s.md#string) | Stores the types of the links with this product. | #### Example ```json { "product": ProductView, - "linkTypes": ["abc123"] + "linkTypes": ["xyz789"] } ``` @@ -4077,12 +4080,12 @@ Defines a monetary value, including a numeric value and a currency code. | 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. | +| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | #### Example ```json -{"currency": "AED", "value": 123.45} +{"currency": "AED", "value": 987.65} ``` @@ -4095,10 +4098,10 @@ Product options provide a way to configure products by making selections of part | 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` | +| `id` - [`ID`](types-f-i.md#id) | The ID of the option. For example, `123` for the first option, `456` for the second option. | +| `multi` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether the option must be selected. | +| `title` - [`String`](types-q-s.md#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 @@ -4107,7 +4110,7 @@ Product options provide a way to configure products by making selections of part { "id": 4, "multi": false, - "required": true, + "required": false, "title": "abc123", "values": [ProductViewOptionValue] } @@ -4123,9 +4126,9 @@ Defines the product fields available to the ProductViewOptionValueProduct and Pr | 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. | +| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. | +| `title` - [`String`](types-q-s.md#string) | The display name of the option value. | +| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product has reached the out-of-stock threshold. | #### Possible Types @@ -4155,16 +4158,16 @@ An implementation of ProductViewOptionValue for configuration values. | 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` | -| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | +| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json { - "id": "4", - "title": "xyz789", + "id": 4, + "title": "abc123", "inStock": false } ``` @@ -4179,24 +4182,24 @@ An implementation of ProductViewOptionValue that adds details about a simple pro | 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. | -| `canEditQuantity` - [`Boolean`](#boolean) | Indicates if the quantity of the option value can be edited. | -| `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. | +| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `isDefault` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option value is the default. | +| `product` - [`SimpleProductView`](types-q-s.md#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`](types-f-i.md#float) | Default quantity of an option value. | +| `canEditQuantity` - [`Boolean`](types-a-b.md#boolean) | Indicates if the quantity of the option value can be edited. | +| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json { "id": "4", - "isDefault": true, + "isDefault": false, "product": SimpleProductView, "quantity": 123.45, - "canEditQuantity": false, - "title": "xyz789", + "canEditQuantity": true, + "title": "abc123", "inStock": true } ``` @@ -4211,20 +4214,20 @@ An implementation of ProductViewOptionValueSwatch for swatches. | 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. | +| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `type` - [`SwatchType`](types-q-s.md#swatchtype) | Indicates the type of the swatch. | +| `value` - [`String`](types-q-s.md#string) | The value of the swatch depending on the type of the swatch. | +| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json { - "id": 4, - "title": "xyz789", + "id": "4", + "title": "abc123", "type": "TEXT", - "value": "abc123", + "value": "xyz789", "inStock": false } ``` @@ -4242,7 +4245,7 @@ Base product price view. Contains the final price after discounts, the regular p | `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` | +| `roles` - [`[String]`](types-q-s.md#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 @@ -4251,7 +4254,7 @@ Base product price view. Contains the final price after discounts, the regular p "final": Price, "regular": Price, "tiers": [ProductViewTierPrice], - "roles": ["abc123"] + "roles": ["xyz789"] } ``` @@ -4304,7 +4307,7 @@ Minimum quantity (inclusive) required to activate this tier price. For example, | 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. | +| `in` - [`[Float]`](types-f-i.md#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 @@ -4344,13 +4347,13 @@ Minimum quantity (inclusive) required to activate this tier price. For example, | 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. | +| `gte` - [`Float`](types-f-i.md#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`](types-f-i.md#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 -{"gte": 123.45, "lt": 987.65} +{"gte": 987.65, "lt": 123.45} ``` @@ -4363,14 +4366,14 @@ Represents a product variant. | Field Name | Description | |------------|-------------| -| `selections` - [`[String!]`](#string) | List of option values that make up the variant. For example, `red`, `blue` or `green` | +| `selections` - [`[String!]`](types-q-s.md#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 { - "selections": ["xyz789"], + "selections": ["abc123"], "product": ProductView } ``` @@ -4386,7 +4389,7 @@ Represents the results of a product variant search. | 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. | +| `cursor` - [`String`](types-q-s.md#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | #### Example @@ -4408,9 +4411,9 @@ Contains details about a product video. For example, a video of the product bein | Field Name | 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` | +| `url` - [`String!`](types-q-s.md#string) | The URL to the product video. For example, `https://example.com/video.mp4` or `https://example.com/video.webm` | +| `description` - [`String`](types-q-s.md#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`](types-q-s.md#string) | The title of the product video. For example, `Product Video` or `Product Assembly Video` | #### Example @@ -4418,8 +4421,8 @@ Contains details about a product video. For example, a video of the product bein { "preview": ProductViewImage, "url": "abc123", - "description": "abc123", - "title": "abc123" + "description": "xyz789", + "title": "xyz789" } ``` @@ -4433,15 +4436,15 @@ User purchase history | Input Field | Description | |-------------|-------------| -| `date` - [`DateTime`](#datetime) | | -| `items` - [`[String]`](#string) | | +| `date` - [`DateTime`](types-c-e.md#datetime) | | +| `items` - [`[String]`](types-q-s.md#string) | | #### Example ```json { "date": "2007-12-03T10:15:30Z", - "items": ["abc123"] + "items": ["xyz789"] } ``` @@ -4458,15 +4461,15 @@ Contains details about a purchase order. | `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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](types-c-e.md#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. | +| `number` - [`String!`](types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -4475,14 +4478,14 @@ Contains details about a purchase order. "approval_flow": [PurchaseOrderRuleApprovalFlow], "available_actions": ["REJECT"], "comments": [PurchaseOrderComment], - "created_at": "abc123", + "created_at": "xyz789", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], "number": "xyz789", "order": CustomerOrder, "quote": Cart, "status": "PENDING", - "uid": "4", + "uid": 4, "updated_at": "xyz789" } ``` @@ -4517,7 +4520,7 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example @@ -4536,19 +4539,19 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | +| `message` - [`String`](types-q-s.md#string) | A formatted message. | +| `name` - [`String`](types-q-s.md#string) | The approver name. | +| `role` - [`String`](types-q-s.md#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. | +| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { - "message": "xyz789", + "message": "abc123", "name": "abc123", - "role": "xyz789", + "role": "abc123", "status": "PENDING", "updated_at": "xyz789" } @@ -4582,16 +4585,16 @@ Contains details about a purchase order approval rule. | 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. | +| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#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. | +| `created_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -4600,13 +4603,13 @@ Contains details about a purchase order approval rule. "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "abc123", - "description": "xyz789", - "name": "abc123", + "created_at": "abc123", + "created_by": "xyz789", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -4691,7 +4694,7 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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. | +| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example @@ -4709,21 +4712,21 @@ Defines a new purchase order approval rule. | 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. | +| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "applies_to": ["4"], + "applies_to": [4], "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", + "description": "xyz789", "name": "abc123", "status": "ENABLED" } @@ -4739,9 +4742,9 @@ Contains metadata that can be used to render rule edit forms. | 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. | +| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4799,8 +4802,8 @@ Contains the approval rules that the customer can see. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4808,7 +4811,7 @@ Contains the approval rules that the customer can see. { "items": [PurchaseOrderApprovalRule], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -4822,17 +4825,17 @@ Contains details about a comment. | 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. | +| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | #### Example ```json { "author": Customer, - "created_at": "xyz789", + "created_at": "abc123", "text": "xyz789", "uid": "4" } @@ -4868,10 +4871,10 @@ Contains details about a status change. | 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. | +| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example @@ -4880,7 +4883,7 @@ Contains details about a status change. "activity": "xyz789", "created_at": "xyz789", "message": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -4895,7 +4898,7 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | +| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | #### Example @@ -4941,8 +4944,8 @@ Contains a list of purchase orders. | 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. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4964,12 +4967,12 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | #### Example ```json -{"purchase_order_uids": ["4"]} +{"purchase_order_uids": [4]} ``` @@ -5004,20 +5007,20 @@ Defines the criteria to use to filter the list of purchase orders. | 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. | +| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `my_approvals` - [`Boolean`](types-a-b.md#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`](types-a-b.md#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, + "company_purchase_orders": false, "created_date": FilterRangeTypeInput, - "my_approvals": true, - "require_my_approval": true, + "my_approvals": false, + "require_my_approval": false, "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 index 7ad66dfea..890d6334d 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md @@ -7,7 +7,7 @@ | 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 | +| `userViewHistory` - [`[ViewHistoryInput!]`](types-t-z.md#viewhistoryinput) | User view history with timestamp | #### Example @@ -48,14 +48,14 @@ Sets quote template expiration date. | 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. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "expiration_date": "abc123", - "template_id": 4 + "expiration_date": "xyz789", + "template_id": "4" } ``` @@ -69,19 +69,19 @@ Sets quote item note. | 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. | +| `item_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `item_uid` - [`ID`](types-f-i.md#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. | +| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "item_id": 4, - "item_uid": 4, - "note": "xyz789", - "templateId": 4 + "item_id": "4", + "item_uid": "4", + "note": "abc123", + "templateId": "4" } ``` @@ -102,7 +102,7 @@ Contains a notification message for a negotiable quote template. ```json { - "message": "xyz789", + "message": "abc123", "type": "xyz789" } ``` @@ -117,10 +117,10 @@ For use on numeric product fields | Field Name | Description | |------------|-------------| -| `count` - [`Int!`](#int) | The number of items in the bucket | -| `from` - [`Float!`](#float) | The minimum amount in a price range | +| `count` - [`Int!`](types-f-i.md#int) | The number of items in the bucket | +| `from` - [`Float!`](types-f-i.md#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 | +| `to` - [`Float`](types-f-i.md#float) | The maximum amount in a price range | #### Example @@ -128,7 +128,7 @@ For use on numeric product fields { "count": 987, "from": 123.45, - "title": "abc123", + "title": "xyz789", "to": 987.65 } ``` @@ -177,8 +177,8 @@ For use on numeric product fields | Input Field | Description | |-------------|-------------| -| `from` - [`Float`](#float) | | -| `to` - [`Float`](#float) | | +| `from` - [`Float`](types-f-i.md#float) | | +| `to` - [`Float`](types-f-i.md#float) | | #### Example @@ -195,7 +195,7 @@ For use on numeric product fields | Field Name | Description | |------------|-------------| | `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | +| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | #### Example @@ -218,7 +218,7 @@ Contains reCAPTCHA form configuration details. |------------|-------------| | `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. | +| `minimum_score` - [`Float`](types-f-i.md#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. | @@ -231,12 +231,12 @@ Contains reCAPTCHA form configuration details. { "badge_position": "abc123", "language_code": "abc123", - "minimum_score": 987.65, + "minimum_score": 123.45, "re_captcha_type": "INVISIBLE", - "technical_failure_message": "abc123", - "theme": "abc123", - "validation_failure_message": "xyz789", - "website_key": "xyz789" + "technical_failure_message": "xyz789", + "theme": "xyz789", + "validation_failure_message": "abc123", + "website_key": "abc123" } ``` @@ -253,9 +253,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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 | +| `is_enabled` - [`Boolean!`](types-a-b.md#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. | +| `minimum_score` - [`Float!`](types-f-i.md#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. | @@ -263,11 +263,11 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { - "badge_position": "xyz789", + "badge_position": "abc123", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], "is_enabled": false, - "language_code": "xyz789", + "language_code": "abc123", "minimum_score": 123.45, "theme": "abc123", "website_key": "xyz789" @@ -286,7 +286,7 @@ Contains reCAPTCHA configuration for a specific form type. |------------|-------------| | `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. | +| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha is enabled for this form type. | #### Example @@ -294,7 +294,7 @@ Contains reCAPTCHA configuration for a specific form type. { "configurations": ReCaptchaConfiguration, "form_type": "PLACE_ORDER", - "is_enabled": true + "is_enabled": false } ``` @@ -353,11 +353,11 @@ Recommendation Unit containing product and other details | Field Name | Description | |------------|-------------| -| `displayOrder` - [`Int`](#int) | Order in which recommendation units are displayed | +| `displayOrder` - [`Int`](types-f-i.md#int) | Order in which recommendation units are displayed | | `pageType` - [`String`](#string) | Page type | -| `productsView` - [`[ProductView]`](#productview) | List of product view | +| `productsView` - [`[ProductView]`](types-k-p.md#productview) | List of product view | | `storefrontLabel` - [`String`](#string) | Storefront label to be displayed on the storefront | -| `totalProducts` - [`Int`](#int) | Total products returned in recommedations | +| `totalProducts` - [`Int`](types-f-i.md#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 | @@ -368,14 +368,14 @@ Recommendation Unit containing product and other details ```json { "displayOrder": 123, - "pageType": "xyz789", + "pageType": "abc123", "productsView": [ProductView], - "storefrontLabel": "abc123", + "storefrontLabel": "xyz789", "totalProducts": 987, - "typeId": "xyz789", - "unitId": "abc123", + "typeId": "abc123", + "unitId": "xyz789", "unitName": "abc123", - "userError": "abc123" + "userError": "xyz789" } ``` @@ -390,12 +390,12 @@ Recommendations response | 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 | +| `totalResults` - [`Int`](types-f-i.md#int) | total number of rec units for which recommendations are returned | #### Example ```json -{"results": [RecommendationUnit], "totalResults": 987} +{"results": [RecommendationUnit], "totalResults": 123} ``` @@ -407,14 +407,14 @@ Recommendations response | 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. | +| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "id": 123, "name": "xyz789" } @@ -435,7 +435,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -448,7 +448,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -473,7 +473,7 @@ Remove coupons from the cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "coupon_codes": ["abc123"] } ``` @@ -496,7 +496,7 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { "cart_id": "xyz789", - "gift_card_code": "abc123" + "gift_card_code": "xyz789" } ``` @@ -510,7 +510,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -528,7 +528,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -546,7 +546,7 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example @@ -564,7 +564,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -583,13 +583,13 @@ Specifies which items to remove from the cart. | 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. | +| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_item_uid": "4" } ``` @@ -604,7 +604,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -622,13 +622,13 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_item_uids": [4], "quote_uid": "4"} +{"quote_item_uids": ["4"], "quote_uid": 4} ``` @@ -641,7 +641,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -659,16 +659,13 @@ Defines the items to remove from the specified negotiable quote. | 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. | +| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{ - "item_uids": ["4"], - "template_id": "4" -} +{"item_uids": [4], "template_id": 4} ``` @@ -681,8 +678,8 @@ Defines which products to remove from a compare list. | 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. | +| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example @@ -700,8 +697,8 @@ Contains the customer's wish list and any errors encountered. | 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. | +| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -722,12 +719,12 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example ```json -{"return_shipping_tracking_uid": "4"} +{"return_shipping_tracking_uid": 4} ``` @@ -758,7 +755,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -794,7 +791,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -814,7 +811,7 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example @@ -836,7 +833,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -854,8 +851,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -885,10 +882,10 @@ Contains information needed to start a return request. ```json { - "comment_text": "xyz789", - "contact_email": "xyz789", + "comment_text": "abc123", + "contact_email": "abc123", "items": [RequestReturnItemInput], - "token": "abc123" + "token": "xyz789" } ``` @@ -902,9 +899,9 @@ Defines properties of a negotiable quote request. | 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. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](types-a-b.md#boolean) | Flag indicating if quote is draft or not. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -914,7 +911,7 @@ Defines properties of a negotiable quote request. "cart_id": 4, "comment": NegotiableQuoteCommentInput, "is_draft": true, - "quote_name": "abc123" + "quote_name": "xyz789" } ``` @@ -928,7 +925,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -946,7 +943,7 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example @@ -967,13 +964,13 @@ Contains information needed to start a return request. | `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. | +| `order_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { - "comment_text": "abc123", + "comment_text": "xyz789", "contact_email": "xyz789", "items": [RequestReturnItemInput], "order_uid": 4 @@ -990,9 +987,9 @@ Contains details about an item to be returned. | 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. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](types-f-i.md#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 @@ -1002,8 +999,8 @@ Contains details about an item to be returned. "entered_custom_attributes": [ EnteredCustomAttributeInput ], - "order_item_uid": 4, - "quantity_to_return": 987.65, + "order_item_uid": "4", + "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -1044,9 +1041,9 @@ Defines the contents of a requisition list. |------------|-------------| | `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. | +| `items_count` - [`Int!`](types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example @@ -1055,10 +1052,10 @@ Defines the contents of a requisition list. { "description": "abc123", "items": RequistionListItems, - "items_count": 123, + "items_count": 987, "name": "xyz789", "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -1072,8 +1069,8 @@ Defines requisition list filters. | 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. | +| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -1095,21 +1092,21 @@ The interface for requisition list items. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | | `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Possible Types | RequisitionListItemInterface Types | |----------------| -| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | -| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | +| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | +| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | | [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | +| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | #### Example @@ -1117,8 +1114,8 @@ The interface for requisition list items. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "sku": "xyz789", + "quantity": 987.65, + "sku": "abc123", "uid": "4" } ``` @@ -1133,9 +1130,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#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. | +| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -1144,7 +1141,7 @@ Defines the items to add. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", + "parent_sku": "abc123", "quantity": 987.65, "selected_options": ["xyz789"], "sku": "xyz789" @@ -1200,7 +1197,7 @@ Defines customer requisition lists. | `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. | +| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -1225,7 +1222,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `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. | +| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | #### Example @@ -1253,10 +1250,10 @@ Contains details about a return. | `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. | +| `order` - [`CustomerOrder`](types-c-e.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -1267,7 +1264,7 @@ Contains details about a return. "created_at": "abc123", "customer": ReturnCustomer, "items": [ReturnItem], - "number": "abc123", + "number": "xyz789", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", @@ -1288,13 +1285,13 @@ Contains details about a return comment. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example ```json { - "author_name": "abc123", + "author_name": "xyz789", "created_at": "abc123", "text": "xyz789", "uid": 4 @@ -1319,8 +1316,8 @@ The customer information for the return. ```json { - "email": "xyz789", - "firstname": "xyz789", + "email": "abc123", + "firstname": "abc123", "lastname": "xyz789" } ``` @@ -1335,12 +1332,12 @@ Contains details about a product being returned. | 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. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](types-f-i.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1348,10 +1345,10 @@ Contains details about a product being returned. { "custom_attributesV2": [AttributeValueInterface], "order_item": OrderItemInterface, - "quantity": 123.45, + "quantity": 987.65, "request_quantity": 123.45, "status": "PENDING", - "uid": 4 + "uid": "4" } ``` @@ -1365,36 +1362,36 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](types-f-i.md#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. | +| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#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. | +| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](types-a-b.md#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. | +| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { - "code": "4", + "code": 4, "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, - "is_unique": true, + "is_required": false, + "is_unique": false, "label": "abc123", "multiline_count": 987, "options": [CustomAttributeOptionInterface], - "sort_order": 987, + "sort_order": 123, "validate_rules": [ValidationRule] } ``` @@ -1454,7 +1451,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `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. | +| `country` - [`Country!`](types-c-e.md#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. | @@ -1465,12 +1462,12 @@ Contains details about the shipping address used for receiving returned items. ```json { "city": "xyz789", - "contact_name": "abc123", + "contact_name": "xyz789", "country": Country, "postcode": "xyz789", "region": Region, - "street": ["xyz789"], - "telephone": "abc123" + "street": ["abc123"], + "telephone": "xyz789" } ``` @@ -1485,12 +1482,15 @@ Contains details about the carrier on a return. | 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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example ```json -{"label": "xyz789", "uid": 4} +{ + "label": "xyz789", + "uid": "4" +} ``` @@ -1506,7 +1506,7 @@ Contains shipping and tracking details. | `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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1535,7 +1535,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "xyz789", "type": "INFORMATION"} +{"text": "abc123", "type": "INFORMATION"} ``` @@ -1595,7 +1595,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | #### Example @@ -1603,7 +1603,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1617,12 +1617,12 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example ```json -{"result": true} +{"result": false} ``` @@ -1659,8 +1659,8 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | #### Example @@ -1681,15 +1681,15 @@ Contain details about the reward points transaction. | `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. | +| `points_change` - [`Float!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example ```json { "balance": RewardPointsAmount, - "change_reason": "abc123", - "date": "xyz789", + "change_reason": "xyz789", + "date": "abc123", "points_change": 987.65 } ``` @@ -1726,8 +1726,8 @@ Contains details about customer's reward points rate. | 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. | +| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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 @@ -1813,7 +1813,7 @@ Contains details about a comment. ```json { - "message": "xyz789", + "message": "abc123", "timestamp": "abc123" } ``` @@ -1828,8 +1828,8 @@ For use on string and other scalar product 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 | +| `count` - [`Int!`](types-f-i.md#int) | The number of items in the bucket | +| `id` - [`ID!`](types-f-i.md#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 @@ -1883,12 +1883,12 @@ A product attribute to filter on ```json { - "attribute": "abc123", + "attribute": "xyz789", "contains": "xyz789", "eq": "xyz789", - "in": ["abc123"], + "in": ["xyz789"], "range": SearchRangeInput, - "startsWith": "abc123" + "startsWith": "xyz789" } ``` @@ -1902,13 +1902,13 @@ A range of numeric values for use in a search | 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 | +| `from` - [`Float`](types-f-i.md#float) | The minimum value to filter on. If not specified, the value of `0` is applied | +| `to` - [`Float`](types-f-i.md#float) | The maximum value to filter on | #### Example ```json -{"from": 987.65, "to": 987.65} +{"from": 987.65, "to": 123.45} ``` @@ -1921,14 +1921,14 @@ Provides navigation for the query response. | 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. | +| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 123, "page_size": 123, "total_pages": 987} +{"current_page": 987, "page_size": 123, "total_pages": 123} ``` @@ -1943,16 +1943,16 @@ Contains details about a selected bundle option. |------------|-------------| | `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 | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example ```json { - "label": "abc123", + "label": "xyz789", "type": "abc123", - "uid": 4, + "uid": "4", "values": [SelectedBundleOptionValue] } ``` @@ -1968,16 +1968,16 @@ Contains details about a value for a selected bundle option. | 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 | +| `original_price` - [`Money!`](types-k-p.md#money) | The original price of the value for the selected bundle product option. | +| `priceV2` - [`Money!`](types-k-p.md#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { - "label": "abc123", + "label": "xyz789", "original_price": Money, "priceV2": Money, "quantity": 123.45, @@ -1995,8 +1995,8 @@ Contains details about a selected configurable option. | 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. | +| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#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. | @@ -2004,10 +2004,10 @@ Contains details about a selected configurable option. ```json { - "configurable_product_option_uid": 4, + "configurable_product_option_uid": "4", "configurable_product_option_value_uid": 4, "option_label": "abc123", - "value_label": "abc123" + "value_label": "xyz789" } ``` @@ -2043,10 +2043,10 @@ Identifies a customized product that has been placed in a cart. | 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. | +| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `is_required` - [`Boolean!`](types-a-b.md#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. | +| `sort_order` - [`Int!`](types-f-i.md#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. | @@ -2057,7 +2057,7 @@ Identifies a customized product that has been placed in a cart. "customizable_option_uid": "4", "is_required": true, "label": "abc123", - "sort_order": 123, + "sort_order": 987, "type": "xyz789", "values": [SelectedCustomizableOptionValue] } @@ -2073,17 +2073,17 @@ Identifies the value of the selected customized option. | 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. | +| `customizable_option_value_uid` - [`ID!`](types-f-i.md#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. | +| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#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", + "customizable_option_value_uid": "4", + "label": "abc123", "price": CartItemSelectedOptionValuePrice, "value": "xyz789" } @@ -2100,7 +2100,7 @@ Describes the payment method selected by the shopper. | Field Name | Description | |------------|-------------| | `code` - [`String!`](#string) | The payment method code. | -| `oope_payment_method_config` - [`OopePaymentMethodConfig`](#oopepaymentmethodconfig) | Configuration for out of process payment methods | +| `oope_payment_method_config` - [`OopePaymentMethodConfig`](types-k-p.md#oopepaymentmethodconfig) | Configuration for out of process payment methods | | `purchase_order_number` - [`String`](#string) | The purchase order number. | | `title` - [`String!`](#string) | The payment method title. | @@ -2126,13 +2126,13 @@ Contains details about the selected shipping method and carrier. | 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. | +| `amount` - [`Money!`](types-k-p.md#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. | +| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -2142,8 +2142,8 @@ Contains details about the selected shipping method and carrier. "amount": Money, "carrier_code": "abc123", "carrier_title": "abc123", - "method_code": "xyz789", - "method_title": "abc123", + "method_code": "abc123", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -2159,16 +2159,13 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "comment": NegotiableQuoteCommentInput, - "quote_uid": "4" -} +{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} ``` @@ -2181,7 +2178,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2199,7 +2196,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2207,7 +2204,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "xyz789" + "cart_id": "abc123" } ``` @@ -2221,7 +2218,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2240,12 +2237,12 @@ Sets the cart as inactive | 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 | +| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart was set as inactive | #### Example ```json -{"error": "abc123", "success": false} +{"error": "abc123", "success": true} ``` @@ -2258,16 +2255,13 @@ Defines the company custom attributes. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for company. | -| `id` - [`ID!`](#id) | The unique ID of a `company` object. | +| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for company. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `company` object. | #### Example ```json -{ - "custom_attributes": [CustomAttributeInput], - "id": "4" -} +{"custom_attributes": [CustomAttributeInput], "id": 4} ``` @@ -2280,7 +2274,7 @@ Contains the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company`](#company) | The company after assigning custom attributes. | +| `company` - [`Company`](types-c-e.md#company) | The company after assigning custom attributes. | #### Example @@ -2298,15 +2292,15 @@ Defines the negotiable quote custom attributes. | 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. | +| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for NegotiableQuote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "custom_attributes": [CustomAttributeInput], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2320,7 +2314,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning custom attributes. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning custom attributes. | #### Example @@ -2339,10 +2333,10 @@ Defines the gift options applied to the cart. | 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. | +| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example @@ -2350,8 +2344,8 @@ Defines the gift options applied to the cart. { "cart_id": "abc123", "gift_message": GiftMessageInput, - "gift_receipt_included": false, - "gift_wrapping_id": 4, + "gift_receipt_included": true, + "gift_wrapping_id": "4", "printed_card_included": true } ``` @@ -2366,7 +2360,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | #### Example @@ -2391,8 +2385,8 @@ Defines the guest email and cart. ```json { - "cart_id": "xyz789", - "email": "abc123" + "cart_id": "abc123", + "email": "xyz789" } ``` @@ -2406,7 +2400,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2424,7 +2418,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2442,15 +2436,15 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2464,7 +2458,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2482,8 +2476,8 @@ Defines the payment method of the specified negotiable quote. | 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. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2504,7 +2498,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2522,8 +2516,8 @@ Defines the shipping address to assign to the negotiable quote. | 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. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example @@ -2546,7 +2540,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2564,14 +2558,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](types-f-i.md#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, + "quote_uid": "4", "shipping_methods": [ShippingMethodInput] } ``` @@ -2586,7 +2580,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2604,15 +2598,15 @@ Defines the shipping address to assign to the negotiable quote template. | 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. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": 4 + "template_id": "4" } ``` @@ -2627,7 +2621,7 @@ Applies a payment method to the cart. | 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. | +| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2648,7 +2642,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2673,7 +2667,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2688,7 +2682,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2728,7 +2722,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2753,8 +2747,8 @@ Defines a gift registry invitee. ```json { - "email": "xyz789", - "name": "abc123" + "email": "abc123", + "name": "xyz789" } ``` @@ -2768,7 +2762,7 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example @@ -2793,7 +2787,7 @@ Defines the sender of an invitation to view a gift registry. ```json { - "message": "xyz789", + "message": "abc123", "name": "abc123" } ``` @@ -2808,8 +2802,8 @@ An input object that defines which requisition list shared with company users th | 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. | +| `customerUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing company users with whom the sender wants to share the requisition list. | +| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -2830,7 +2824,7 @@ Result of sharing a requisition list by email. | Field Name | Description | |------------|-------------| -| `sent_count` - [`Int!`](#int) | Number of notification emails successfully sent. | +| `sent_count` - [`Int!`](types-f-i.md#int) | Number of notification emails successfully sent. | | `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Per-email validation or delivery issues. | #### Example @@ -2857,7 +2851,7 @@ The result of sharing a requisition list by token. #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -2921,7 +2915,7 @@ Shared requisition list view for a recipient. ```json { "requisition_list": RequisitionList, - "sender_name": "xyz789" + "sender_name": "abc123" } ``` @@ -2952,12 +2946,12 @@ Defines whether bundle items must be shipped together. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Example @@ -2965,7 +2959,7 @@ Defines whether bundle items must be shipped together. { "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "quantity_shipped": 987.65 @@ -2982,30 +2976,30 @@ Order shipment item details. | 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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](types-k-p.md#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_sale_price` - [`Money!`](types-k-p.md#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. | +| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example ```json { - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_shipped": 123.45 } ``` @@ -3030,7 +3024,7 @@ Contains order shipment tracking details. ```json { "carrier": "abc123", - "number": "abc123", + "number": "xyz789", "title": "abc123", "tracking_url": "abc123" } @@ -3053,7 +3047,7 @@ A simple key value object. ```json { - "key": "xyz789", + "key": "abc123", "value": "xyz789" } ``` @@ -3068,9 +3062,9 @@ Defines a single shipping address. | 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. | +| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_address_uid` - [`ID`](types-f-i.md#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. | @@ -3079,9 +3073,9 @@ Defines a single shipping address. ```json { "address": CartAddressInput, - "customer_address_id": 123, + "customer_address_id": 987, "customer_address_uid": 4, - "customer_notes": "abc123", + "customer_notes": "xyz789", "pickup_location_code": "abc123" } ``` @@ -3096,29 +3090,29 @@ Contains shipping addresses and methods. | 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. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#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. | +| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](types-f-i.md#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.)* | +| `id` - [`Int`](types-f-i.md#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. | +| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](types-a-b.md#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. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | | `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example @@ -3127,27 +3121,27 @@ Contains shipping addresses and methods. { "available_shipping_methods": [AvailableShippingMethod], "cart_items_v2": [CartItemInterface], - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", - "customer_notes": "abc123", - "fax": "xyz789", - "firstname": "xyz789", + "customer_notes": "xyz789", + "fax": "abc123", + "firstname": "abc123", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "pickup_location_code": "xyz789", + "pickup_location_code": "abc123", "postcode": "abc123", "prefix": "xyz789", "region": CartAddressRegion, "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": 4, + "suffix": "abc123", + "telephone": "xyz789", + "uid": "4", "vat_id": "xyz789" } ``` @@ -3162,7 +3156,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | #### Example @@ -3180,11 +3174,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](types-k-p.md#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. | +| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | #### Example @@ -3215,7 +3209,7 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "abc123", + "carrier_code": "xyz789", "method_code": "xyz789" } ``` @@ -3230,25 +3224,25 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#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 | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#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 | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#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. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -3262,16 +3256,16 @@ An implementation for simple product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": true, - "is_salable": true, - "max_qty": 987.65, + "is_available": false, + "is_salable": 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": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -3287,92 +3281,92 @@ Defines a simple product, which is tangible and is usually sold in single units | 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. | +| `categories` - [`[CategoryInterface]`](types-c-e.md#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. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](types-k-p.md#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. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#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 | +| `min_sale_qty` - [`Float`](types-f-i.md#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. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#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. | +| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#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. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](types-f-i.md#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 | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#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 | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#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. | +| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "xyz789", - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "abc123", "min_sale_qty": 123.45, - "name": "abc123", + "name": "xyz789", "new_from_date": "xyz789", "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789", - "weight": 123.45 + "url_key": "abc123", + "weight": 987.65 } ``` @@ -3386,27 +3380,27 @@ Represents a single-SKU product without selectable variants. Because there are n | 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. | +| `addToCartAllowed` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](types-a-b.md#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]`](types-k-p.md#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. | +| `id` - [`ID!`](types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | +| `images` - [`[ProductViewImage]`](types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image`, and `swatch`. | +| `videos` - [`[ProductViewVideo]`](types-k-p.md#productviewvideo) | A list of videos defined for the product. | +| `inputOptions` - [`[ProductViewInputOption]`](types-k-p.md#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`](types-c-e.md#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. | +| `price` - [`ProductViewPrice`](types-k-p.md#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. | +| `links` - [`[ProductViewLink]`](types-k-p.md#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 | @@ -3414,24 +3408,24 @@ Represents a single-SKU product without selectable variants. Because there are n ```json { - "addToCartAllowed": true, - "inStock": false, - "lowStock": true, + "addToCartAllowed": false, + "inStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "inputOptions": [ProductViewInputOption], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", + "metaDescription": "abc123", "metaKeyword": "abc123", - "metaTitle": "abc123", + "metaTitle": "xyz789", "name": "xyz789", "price": ProductViewPrice, - "shortDescription": "xyz789", + "shortDescription": "abc123", "sku": "xyz789", - "externalId": "abc123", + "externalId": "xyz789", "url": "abc123", "urlKey": "abc123", "links": [ProductViewLink], @@ -3451,10 +3445,10 @@ Contains details about simple products added to a requisition list. | 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. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | | `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3463,8 +3457,8 @@ Contains details about simple products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "sku": "xyz789", - "uid": "4" + "sku": "abc123", + "uid": 4 } ``` @@ -3481,9 +3475,9 @@ Contains a simple 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. | -| `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. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -3492,7 +3486,7 @@ Contains a simple product wish list item. "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": "4", + "id": 4, "product": ProductInterface, "quantity": 987.65 } @@ -3516,8 +3510,8 @@ Smart button payment inputs ```json { - "payment_source": "xyz789", - "payments_order_id": "abc123", + "payment_source": "abc123", + "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } ``` @@ -3530,13 +3524,13 @@ Smart button payment inputs | 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 | +| `app_switch_when_available` - [`Boolean`](types-a-b.md#boolean) | Indicated whether to use App Switch on enabled mobile devices | +| `button_styles` - [`ButtonStyles`](types-a-b.md#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 | +| `display_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](types-k-p.md#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 | @@ -3548,15 +3542,15 @@ Smart button payment inputs { "app_switch_when_available": false, "button_styles": ButtonStyles, - "code": "xyz789", + "code": "abc123", "display_message": false, - "display_venmo": true, - "is_visible": false, + "display_venmo": false, + "is_visible": true, "message_styles": MessageStyles, "payment_intent": "abc123", "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "abc123" + "sort_order": "xyz789", + "title": "xyz789" } ``` @@ -3596,7 +3590,7 @@ Defines a possible sort field. ```json { - "label": "xyz789", + "label": "abc123", "value": "abc123" } ``` @@ -3686,15 +3680,15 @@ Contains product attributes that be used for sorting in a `productSearch` query | `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 | +| `numeric` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | #### Example ```json { "attribute": "abc123", - "frontendInput": "abc123", - "label": "xyz789", + "frontendInput": "xyz789", + "label": "abc123", "numeric": true } ``` @@ -3709,17 +3703,17 @@ For retrieving statistics across multiple buckets | Field Name | Description | |------------|-------------| -| `max` - [`Float!`](#float) | The maximum value | -| `min` - [`Float!`](#float) | The minimum value | +| `max` - [`Float!`](types-f-i.md#float) | The maximum value | +| `min` - [`Float!`](types-f-i.md#float) | The minimum value | | `title` - [`String!`](#string) | The display text for the bucket | #### Example ```json { - "max": 987.65, - "min": 987.65, - "title": "abc123" + "max": 123.45, + "min": 123.45, + "title": "xyz789" } ``` @@ -3733,71 +3727,71 @@ Contains information about a store's configuration. | Field Name | Description | |------------|-------------| -| `allow_company_registration` - [`Boolean!`](#boolean) | Indicates if company registration is allowed | +| `allow_company_registration` - [`Boolean!`](types-a-b.md#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. | +| `autocomplete_on_storefront` - [`Boolean`](types-a-b.md#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_expires_in_days` - [`Int`](types-f-i.md#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. | +| `cart_summary_display_quantity` - [`Int`](types-f-i.md#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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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. | +| `company_credit_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates if company credit is enabled. | +| `company_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates if B2B company functionality is enabled | +| `configurable_product_image` - [`ProductImageThumbnail!`](types-k-p.md#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. | +| `contact_enabled` - [`Boolean!`](types-a-b.md#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. | +| `create_account_confirmation` - [`Boolean`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](types-f-i.md#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 | +| `display_product_prices_in_catalog` - [`Int!`](types-f-i.md#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](types-f-i.md#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](types-a-b.md#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. | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/include_in_subtotal | +| `graphql_share_customer_group` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](types-f-i.md#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 | +| `grouped_product_image` - [`ProductImageThumbnail!`](types-k-p.md#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | +| `is_checkout_agreements_enabled` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#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` - [`Int`](types-f-i.md#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). | @@ -3814,70 +3808,70 @@ Contains information about a store's configuration. | `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. | +| `max_items_in_order_summary` - [`Int`](types-f-i.md#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. | +| `minicart_display` - [`Boolean`](types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](types-f-i.md#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. | +| `newsletter_enabled` - [`Boolean!`](types-a-b.md#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. | +| `order_cancellation_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/zero_tax | +| `printed_card_priceV2` - [`Money`](types-k-p.md#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `quickorder_active` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether quick order functionality is enabled. | +| `quote_minimum_amount` - [`Float`](types-f-i.md#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_link_validity_days` - [`Int!`](types-f-i.md#int) | Configuration data from btob/requisition_list_sharing/link_validity_days | +| `requisition_list_share_max_recipients` - [`Int!`](types-f-i.md#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 | +| `requisition_list_sharing_enabled` - [`Boolean!`](types-a-b.md#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. | +| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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 | +| `share_active_segments` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | +| `share_applied_cart_rule` - [`Boolean!`](types-a-b.md#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. | +| `shopping_assistance_enabled` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from login_as_customer/general/enabled | +| `shopping_cart_display_full_summary` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#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. | +| `store_sort_order` - [`Int`](types-f-i.md#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. | +| `use_store_in_url` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](types-f-i.md#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_enable_for_specific_countries` - [`Boolean`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#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_sort_order` - [`Int`](types-f-i.md#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 @@ -3885,150 +3879,150 @@ Contains information about a store's configuration. ```json { "allow_company_registration": false, - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "xyz789", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "abc123", "allow_items": "abc123", - "allow_order": "abc123", + "allow_order": "xyz789", "allow_printed_card": "abc123", "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", - "base_link_url": "abc123", + "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": "xyz789", + "base_url": "xyz789", + "cart_expires_in_days": 987, + "cart_gift_wrapping": "abc123", "cart_merge_preference": "abc123", "cart_printed_card": "abc123", - "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "xyz789", + "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_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_payment_from_specific_countries": "xyz789", - "check_money_order_send_check_to": "abc123", + "check_money_order_payment_from_specific_countries": "abc123", + "check_money_order_send_check_to": "xyz789", "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", "company_credit_enabled": false, - "company_enabled": false, + "company_enabled": true, "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", + "configurable_thumbnail_source": "abc123", "contact_enabled": true, "countries_with_required_region": "xyz789", - "create_account_confirmation": true, + "create_account_confirmation": false, "customer_access_token_lifetime": 123.45, "default_country": "abc123", "default_display_currency_code": "xyz789", "display_product_prices_in_catalog": 987, - "display_shipping_prices": 987, - "display_state_if_optional": false, - "enable_multiple_wishlists": "xyz789", - "fixed_product_taxes_apply_tax_to_fpt": true, - "fixed_product_taxes_display_prices_in_emails": 123, + "display_shipping_prices": 123, + "display_state_if_optional": true, + "enable_multiple_wishlists": "abc123", + "fixed_product_taxes_apply_tax_to_fpt": false, + "fixed_product_taxes_display_prices_in_emails": 987, "fixed_product_taxes_display_prices_in_product_lists": 123, - "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 123, - "fixed_product_taxes_enable": true, + "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": false, - "grid_per_page": 123, - "grid_per_page_values": "xyz789", + "grid_per_page": 987, + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": true, + "is_checkout_agreements_enabled": false, "is_default_store": true, - "is_default_store_group": true, + "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", - "list_mode": "abc123", - "list_per_page": 123, - "list_per_page_values": "abc123", - "locale": "abc123", - "magento_reward_general_is_enabled": "abc123", + "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": "xyz789", + "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": "xyz789", - "magento_reward_points_invitation_customer_limit": "xyz789", + "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": "abc123", - "magento_reward_points_register": "xyz789", + "magento_reward_points_newsletter": "abc123", + "magento_reward_points_order": "xyz789", + "magento_reward_points_register": "abc123", "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "abc123", - "max_items_in_order_summary": 123, + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "abc123", "minicart_display": true, - "minicart_max_items": 123, - "minimum_password_length": "abc123", + "minicart_max_items": 987, + "minimum_password_length": "xyz789", "newsletter_enabled": true, - "optional_zip_countries": "xyz789", + "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_grandtotal": true, + "orders_invoices_credit_memos_display_price": 987, "orders_invoices_credit_memos_display_shipping_amount": 123, "orders_invoices_credit_memos_display_subtotal": 123, "orders_invoices_credit_memos_display_zero_tax": true, "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": "abc123", - "requisition_list_share_link_validity_days": 123, + "product_url_suffix": "abc123", + "quickorder_active": true, + "quote_minimum_amount": 987.65, + "quote_minimum_amount_message": "xyz789", + "required_character_classes_number": "xyz789", + "requisition_list_share_link_validity_days": 987, "requisition_list_share_max_recipients": 123, - "requisition_list_share_storefront_path": "abc123", - "requisition_list_sharing_enabled": true, - "returns_enabled": "abc123", + "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_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": "abc123", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "xyz789", "share_active_segments": false, "share_applied_cart_rule": true, "shopping_assistance_checkbox_title": "xyz789", - "shopping_assistance_checkbox_tooltip": "xyz789", - "shopping_assistance_enabled": true, - "shopping_cart_display_full_summary": false, + "shopping_assistance_checkbox_tooltip": "abc123", + "shopping_assistance_enabled": false, + "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_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, + "shopping_cart_display_zero_tax": true, "store_code": "4", "store_group_code": "4", - "store_group_name": "xyz789", - "store_name": "abc123", + "store_group_name": "abc123", + "store_name": "xyz789", "store_sort_order": 987, - "timezone": "abc123", + "timezone": "xyz789", "title_separator": "abc123", "use_store_in_url": true, - "website_code": "4", - "website_name": "abc123", + "website_code": 4, + "website_name": "xyz789", "weight_unit": "abc123", - "zero_subtotal_enable_for_specific_countries": true, + "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_action": "abc123", "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 987, + "zero_subtotal_sort_order": 123, "zero_subtotal_title": "abc123" } ``` @@ -4042,7 +4036,7 @@ The `String` scalar type represents textual data, represented as UTF-8 character #### Example ```json -"xyz789" +"abc123" ``` @@ -4089,27 +4083,27 @@ Specifies the quote template properties to update. | Input Field | Description | |-------------|-------------| -| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](#negotiablequotecommentattachmentinput) | Negotiable quote template comment file attachments. | +| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](types-k-p.md#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 | +| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](types-f-i.md#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. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "abc123", + "comment": "xyz789", "max_order_commitment": 123, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], - "template_id": "4" + "template_id": 4 } ``` @@ -4162,8 +4156,8 @@ Represents the subtree of the categories to retrieve. | 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. | +| `depth` - [`Int!`](types-f-i.md#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!`](types-f-i.md#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 @@ -4185,14 +4179,14 @@ Represents the subtree of the categories to retrieve. | SwatchDataInterface Types | |----------------| -| [`ColorSwatchData`](#colorswatchdata) | -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | +| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | +| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](types-t-z.md#textswatchdata) | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -4269,7 +4263,7 @@ Synchronizes the payment order details ```json { "cartId": "xyz789", - "id": "abc123" + "id": "xyz789" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md index 113d93b11..379174e72 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md @@ -8,17 +8,17 @@ Contains tax item details. | 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. | +| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | #### Example ```json { "amount": Money, - "rate": 123.45, - "title": "xyz789" + "rate": 987.65, + "title": "abc123" } ``` @@ -48,7 +48,7 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -86,9 +86,9 @@ Defines a price based on the quantity purchased. | 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. | +| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -110,7 +110,7 @@ Defines the input schema for unassigning a child company from its parent company | Input Field | Description | |-------------|-------------| -| `child_company_id` - [`ID!`](#id) | The unique ID of the child company. | +| `child_company_id` - [`ID!`](types-f-i.md#id) | The unique ID of the child company. | #### Example @@ -128,7 +128,7 @@ Contains the response to the request to unassign a child company. | Field Name | Description | |------------|-------------| -| `company_hierarchy` - [`CompanyHierarchy!`](#companyhierarchy) | The updated company relation hierarchy for the current company. | +| `company_hierarchy` - [`CompanyHierarchy!`](types-c-e.md#companyhierarchy) | The updated company relation hierarchy for the current company. | #### Example @@ -144,24 +144,24 @@ Contains the response to the request to unassign a child company. | Input Field | Description | |-------------|-------------| -| `unitName` - [`String`](#string) | | -| `storefrontLabel` - [`String`](#string) | | -| `pagePlacement` - [`String`](#string) | | -| `displayNumber` - [`Int`](#int) | | -| `pageType` - [`String`](#string) | | -| `unitStatus` - [`String`](#string) | | -| `typeId` - [`String`](#string) | | -| `filterRules` - [`[FilterRuleInput]`](#filterruleinput) | | +| `unitName` - [`String`](types-q-s.md#string) | | +| `storefrontLabel` - [`String`](types-q-s.md#string) | | +| `pagePlacement` - [`String`](types-q-s.md#string) | | +| `displayNumber` - [`Int`](types-f-i.md#int) | | +| `pageType` - [`String`](types-q-s.md#string) | | +| `unitStatus` - [`String`](types-q-s.md#string) | | +| `typeId` - [`String`](types-q-s.md#string) | | +| `filterRules` - [`[FilterRuleInput]`](types-f-i.md#filterruleinput) | | #### Example ```json { "unitName": "xyz789", - "storefrontLabel": "abc123", - "pagePlacement": "abc123", + "storefrontLabel": "xyz789", + "pagePlacement": "xyz789", "displayNumber": 123, - "pageType": "xyz789", + "pageType": "abc123", "unitStatus": "abc123", "typeId": "xyz789", "filterRules": [FilterRuleInput] @@ -178,8 +178,8 @@ Modifies the specified items in the cart. | 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. | +| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example @@ -200,8 +200,8 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | +| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | #### Example @@ -222,7 +222,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -240,7 +240,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -258,7 +258,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | #### Example @@ -276,7 +276,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -294,7 +294,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | +| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | #### Example @@ -312,12 +312,12 @@ Defines updates to a `GiftRegistry` object. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -326,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" @@ -344,15 +344,15 @@ Defines updates to an item in a gift registry. | 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. | +| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { - "gift_registry_item_uid": 4, + "gift_registry_item_uid": "4", "note": "xyz789", "quantity": 123.45 } @@ -368,7 +368,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -386,7 +386,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -404,11 +404,11 @@ Defines updates to an existing registrant. | 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. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -418,8 +418,8 @@ Defines updates to an existing registrant. GiftRegistryDynamicAttributeInput ], "email": "abc123", - "firstname": "xyz789", - "gift_registry_registrant_uid": "4", + "firstname": "abc123", + "gift_registry_registrant_uid": 4, "lastname": "xyz789" } ``` @@ -434,7 +434,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -452,7 +452,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -470,15 +470,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -492,7 +492,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -510,15 +510,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": "4" + "template_id": 4 } ``` @@ -554,23 +554,23 @@ Defines the changes to be made to an approval rule. | 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. | +| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { - "applies_to": ["4"], + "applies_to": [4], "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", - "name": "abc123", + "description": "xyz789", + "name": "xyz789", "status": "ENABLED", "uid": 4 } @@ -586,8 +586,8 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | +| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | #### Example @@ -608,10 +608,10 @@ Defines which items in a requisition list to update. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | #### Example @@ -620,7 +620,7 @@ Defines which items in a requisition list to update. "entered_options": [EnteredOptionInput], "item_id": 4, "quantity": 123.45, - "selected_options": ["xyz789"] + "selected_options": ["abc123"] } ``` @@ -634,7 +634,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -652,7 +652,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -670,16 +670,16 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](types-f-i.md#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, + "name": "abc123", + "uid": "4", "visibility": "PUBLIC" } ``` @@ -694,9 +694,9 @@ Defines the input for returning matching companies the customer is assigned to. | 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. | +| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example @@ -718,8 +718,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -740,13 +740,13 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `message` - [`String!`](types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -779,7 +779,7 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | #### Example @@ -798,7 +798,7 @@ Contains the results of validation attempts. | 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. | +| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -820,7 +820,7 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](#string) | Validation rule value. | +| `value` - [`String`](types-q-s.md#string) | Validation rule value. | #### Example @@ -883,8 +883,8 @@ Retrieves the vault configuration | Field Name | Description | |------------|-------------| -| `is_vault_enabled` - [`Boolean`](#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The parameters required to load the Paypal JS SDK | +| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | | `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | #### Example @@ -907,10 +907,10 @@ Vault payment inputs | 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. | +| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | #### Example @@ -933,7 +933,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](#paymentsourceinput) | The payment source information | +| `payment_source` - [`PaymentSourceInput!`](types-k-p.md#paymentsourceinput) | The payment source information | #### Example @@ -951,15 +951,15 @@ User view history | Input Field | Description | |-------------|-------------| -| `date` - [`DateTime`](#datetime) | | -| `sku` - [`String`](#string) | | +| `date` - [`DateTime`](types-c-e.md#datetime) | | +| `sku` - [`String`](types-q-s.md#string) | | #### Example ```json { "date": "2007-12-03T10:15:30Z", - "sku": "xyz789" + "sku": "abc123" } ``` @@ -973,15 +973,15 @@ User view history | Input Field | Description | |-------------|-------------| -| `dateTime` - [`DateTime`](#datetime) | | -| `sku` - [`String!`](#string) | | +| `dateTime` - [`DateTime`](types-c-e.md#datetime) | | +| `sku` - [`String!`](types-q-s.md#string) | | #### Example ```json { "dateTime": "2007-12-03T10:15:30Z", - "sku": "xyz789" + "sku": "abc123" } ``` @@ -995,22 +995,22 @@ An implementation for virtual product cart items. | 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 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. | -| `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. | +| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1021,17 +1021,17 @@ An implementation for virtual product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "is_available": false, - "is_salable": true, + "is_available": true, + "is_salable": false, "max_qty": 123.45, "min_qty": 123.45, - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -1045,46 +1045,46 @@ Defines a virtual product, which is a non-tangible product that does not require | 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 | +| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](types-k-p.md#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 | +| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | #### Example @@ -1092,37 +1092,37 @@ Defines a virtual product, which is a non-tangible product that does not require { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": false, + "gift_message_available": true, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "xyz789", "manufacturer": 987, - "max_sale_qty": 987.65, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "xyz789", + "name": "abc123", "new_from_date": "abc123", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "abc123", @@ -1143,11 +1143,11 @@ Contains details about virtual products added to a requisition list. | 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. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1156,8 +1156,8 @@ Contains details about virtual products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "sku": "xyz789", - "uid": "4" + "sku": "abc123", + "uid": 4 } ``` @@ -1171,21 +1171,21 @@ Contains a virtual product wish list item. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -1202,14 +1202,14 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -1242,24 +1242,24 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | -| `items_count` - [`Int`](#int) | The number of items in the wish list. | +| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `Wishlist` object. | +| `items_count` - [`Int`](types-f-i.md#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. | +| `name` - [`String`](types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](types-q-s.md#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_count": 123, + "id": 4, + "items_count": 987, "items_v2": WishlistItems, - "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "xyz789", + "name": "xyz789", + "sharing_code": "abc123", + "updated_at": "abc123", "visibility": "PUBLIC" } ``` @@ -1275,9 +1275,9 @@ Contains details about errors encountered when a customer added wish list items | 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. | +| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example @@ -1286,7 +1286,7 @@ Contains details about errors encountered when a customer added wish list items "code": "PRODUCT_NOT_FOUND", "message": "xyz789", "wishlistId": "4", - "wishlistItemId": 4 + "wishlistItemId": "4" } ``` @@ -1322,13 +1322,16 @@ Specifies the IDs of items to copy and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json -{"quantity": 987.65, "wishlist_item_id": 4} +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} ``` @@ -1341,11 +1344,11 @@ Defines the items to add to a wish list. | 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. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | #### Example @@ -1354,8 +1357,8 @@ Defines the items to add to a wish list. "entered_options": [EnteredOptionInput], "parent_sku": "abc123", "quantity": 123.45, - "selected_options": ["4"], - "sku": "abc123" + "selected_options": [4], + "sku": "xyz789" } ``` @@ -1369,23 +1372,23 @@ The interface for wish list items. | 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. | +| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | -| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | +| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | +| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | +| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | +| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | #### Example @@ -1394,10 +1397,10 @@ The interface for wish list items. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1411,8 +1414,8 @@ Specifies the IDs of the items to move and their quantities. | 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. | +| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example @@ -1430,21 +1433,21 @@ Defines updates to items in a wish list. | 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. | +| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "entered_options": [EnteredOptionInput], "quantity": 123.45, - "selected_options": ["4"], - "wishlist_item_id": "4" + "selected_options": [4], + "wishlist_item_id": 4 } ``` @@ -1459,7 +1462,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example From 67d11dcb0ed2b881cb8055c82e1be11eef778f92 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 3 Aug 2026 17:30:40 -0500 Subject: [PATCH 2/3] chore: add .scout to .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 58f3371bc..c76c2f3cb 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ .vscode .cursor .claude +.scout # environment variables .env From 5b3451ebcbac8e068c380bba45bc0e8ec1d9f188 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 3 Aug 2026 18:56:03 -0500 Subject: [PATCH 3/3] COMDOX-1759: rewrite anchor links as absolute paths, not relative filenames --- scripts/generate-spectaql-md.js | 36 +- .../graphql-api-2-4-6-mutations.md | 771 ++-- .../graphql-api-2-4-6-queries.md | 592 +-- .../graphql-api-2-4-6-types-a-b.md | 783 ++-- .../graphql-api-2-4-6-types-c-e.md | 2620 +++++++------ .../graphql-api-2-4-6-types-f-i.md | 939 ++--- .../graphql-api-2-4-6-types-k-p.md | 1369 ++++--- .../graphql-api-2-4-6-types-q-s.md | 847 +++-- .../graphql-api-2-4-6-types-t-z.md | 554 +-- .../graphql-api-2-4-7-mutations.md | 949 +++-- .../graphql-api-2-4-7-queries.md | 932 ++--- .../graphql-api-2-4-7-types-a-b.md | 900 ++--- .../graphql-api-2-4-7-types-c-e.md | 2863 +++++++-------- .../graphql-api-2-4-7-types-f-i.md | 918 +++-- .../graphql-api-2-4-7-types-k-p.md | 1505 ++++---- .../graphql-api-2-4-7-types-q-s.md | 1185 +++--- .../graphql-api-2-4-7-types-t-z.md | 526 ++- .../graphql-api-2-4-8-mutations.md | 1020 +++--- .../graphql-api-2-4-8-queries.md | 976 ++--- .../graphql-api-2-4-8-types-a-b.md | 993 ++--- .../graphql-api-2-4-8-types-c-e.md | 3253 ++++++++--------- .../graphql-api-2-4-8-types-f-i.md | 1059 +++--- .../graphql-api-2-4-8-types-k-p.md | 1687 +++++---- .../graphql-api-2-4-8-types-q-s.md | 1329 ++++--- .../graphql-api-2-4-8-types-t-z.md | 616 ++-- .../graphql-api-2-4-9-mutations.md | 1068 +++--- .../graphql-api-2-4-9-queries.md | 970 ++--- .../graphql-api-2-4-9-types-a-b.md | 928 ++--- .../graphql-api-2-4-9-types-c-e.md | 3081 ++++++++-------- .../graphql-api-2-4-9-types-f-i.md | 1023 +++--- .../graphql-api-2-4-9-types-k-p.md | 1558 ++++---- .../graphql-api-2-4-9-types-q-s.md | 1255 ++++--- .../graphql-api-2-4-9-types-t-z.md | 550 +-- .../graphql-api-saas-mutations.md | 1174 +++--- .../autogenerated/graphql-api-saas-queries.md | 780 ++-- .../graphql-api-saas-types-a-b.md | 849 ++--- .../graphql-api-saas-types-c-e.md | 2803 +++++++------- .../graphql-api-saas-types-f-i.md | 1006 ++--- .../graphql-api-saas-types-k-p.md | 1659 ++++----- .../graphql-api-saas-types-q-s.md | 1158 +++--- .../graphql-api-saas-types-t-z.md | 475 +-- 41 files changed, 24778 insertions(+), 24781 deletions(-) diff --git a/scripts/generate-spectaql-md.js b/scripts/generate-spectaql-md.js index da3b65cc1..ac66bc217 100644 --- a/scripts/generate-spectaql-md.js +++ b/scripts/generate-spectaql-md.js @@ -102,20 +102,28 @@ function collectHeadingPages(headingToPage, content, pageFile) { } } -// Re-point bare `(#anchor)` links to `pageFile#anchor` when their target -// lives on a different page than the link itself. The link text reliably -// names the target (SpectaQL always links a field/argument to its own type), -// so matching it exactly against the case-sensitive heading map resolves the -// target unambiguously — no need to guess from the anchor text alone. +// Re-point bare `(#anchor)` links to an absolute `/pageFile#anchor` +// link when their target lives on a different page than the link itself. +// A bare relative filename (`types-c-e.md#anchor`) resolves against the +// fragment's own physical location (`src/pages/includes/autogenerated/`), +// where no such file exists — only the prefixed `graphql-api-- +// types-c-e.md` does. The rest of the repo's cross-page links use an +// absolute path rooted at `src/pages` (e.g. +// `/reference/graphql/latest/types-c-e.md#anchor`), which resolves correctly +// regardless of where the fragment physically lives, so rewritten links use +// that same convention. The link text reliably names the target (SpectaQL +// always links a field/argument to its own type), so matching it exactly +// against the case-sensitive heading map resolves the target unambiguously — +// no need to guess from the anchor text alone. // List types render as `[Type!]`, nesting a nested `[...]` pair inside the // label itself, so the label can't be captured with a plain `[^\]]*` — that // stops at the list type's own inner `]`. Allow one level of nested brackets. -function rewriteBareAnchors(content, currentPageFile, headingToPage) { +function rewriteBareAnchors(content, currentPageFile, headingToPage, basePath) { return content.replace(/\[((?:[^\[\]\n]|\[[^\[\]\n]*\])*)\]\(#([a-z0-9_-]+)\)/g, (fullMatch, label, anchor) => { const cleanLabel = label.replace(/`/g, '').replace(/[![\]]/g, '').trim(); const targetPage = headingToPage.get(cleanLabel); if (!targetPage || targetPage === currentPageFile) return fullMatch; - return `[${label}](${targetPage}#${anchor})`; + return `[${label}](${basePath}/${targetPage}#${anchor})`; }); } @@ -316,10 +324,16 @@ for (const schema of toRun) { collectHeadingPages(headingToPage, chunk.content, `types-${chunk.suffix}.md`); } + // Absolute path the rewritten links resolve against, e.g. + // `/reference/graphql/latest` — matches the convention used by hand-written + // cross-links elsewhere in the repo (see rewriteBareAnchors above for why a + // bare relative filename doesn't work from inside a fragment file). + const basePath = '/' + path.relative(path.resolve(ROOT, 'src/pages'), path.resolve(ROOT, indexDir)); + // Queries file: preamble (endpoint/header boilerplate) + queries section. { const fragmentFile = `${baseName}-queries.md`; - const body = rewriteBareAnchors(queriesBody, 'index.md', headingToPage); + const body = rewriteBareAnchors(queriesBody, 'index.md', headingToPage, basePath); fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); console.log(` wrote ${fragmentFile}`); pageSpecs.push({ @@ -334,7 +348,7 @@ for (const schema of toRun) { // Mutations section. if (mutationsBody) { const fragmentFile = `${baseName}-mutations.md`; - const body = rewriteBareAnchors(mutationsBody, 'mutations.md', headingToPage); + const body = rewriteBareAnchors(mutationsBody, 'mutations.md', headingToPage, basePath); fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); console.log(` wrote ${fragmentFile}`); pageSpecs.push({ @@ -350,7 +364,7 @@ for (const schema of toRun) { // forward-compatibility). if (subscriptionsBody) { const fragmentFile = `${baseName}-subscriptions.md`; - const body = rewriteBareAnchors(subscriptionsBody, 'subscriptions.md', headingToPage); + const body = rewriteBareAnchors(subscriptionsBody, 'subscriptions.md', headingToPage, basePath); fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); console.log(` wrote ${fragmentFile}`); pageSpecs.push({ @@ -367,7 +381,7 @@ for (const schema of toRun) { const range = TYPE_LETTER_RANGES.find(entry => entry.suffix === chunk.suffix); const pageFile = `types-${chunk.suffix}.md`; const fragmentFile = `${baseName}-types-${chunk.suffix}.md`; - const body = rewriteBareAnchors(chunk.content, pageFile, headingToPage); + const body = rewriteBareAnchors(chunk.content, pageFile, headingToPage, basePath); fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); console.log(` wrote ${fragmentFile}`); pageSpecs.push({ 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 8d98b9fc0..1fd483070 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 @@ -4,13 +4,13 @@ Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](/reference/graphql/2-4-6/types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -44,13 +44,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](/reference/graphql/2-4-6/types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -88,13 +88,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](/reference/graphql/2-4-6/types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -132,14 +132,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-6/types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](/reference/graphql/2-4-6/types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -188,14 +188,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](/reference/graphql/2-4-6/types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -224,7 +224,7 @@ mutation addProductsToCart( ```json { - "cartId": "xyz789", + "cartId": "abc123", "cartItems": [CartItemInput] } ``` @@ -248,13 +248,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-6/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](/reference/graphql/2-4-6/types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -288,9 +288,9 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -302,14 +302,14 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](/reference/graphql/2-4-6/types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](/reference/graphql/2-4-6/types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -358,14 +358,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](/reference/graphql/2-4-6/types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -393,10 +393,7 @@ mutation addProductsToWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItems": [WishlistItemInput] -} +{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} ``` ##### Response @@ -418,13 +415,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](/reference/graphql/2-4-6/types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](/reference/graphql/2-4-6/types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -464,13 +461,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](/reference/graphql/2-4-6/types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -514,14 +511,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -550,10 +547,7 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{ - "requisitionListUid": "4", - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -566,7 +560,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } } } @@ -578,13 +572,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](/reference/graphql/2-4-6/types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](/reference/graphql/2-4-6/types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -618,13 +612,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](/reference/graphql/2-4-6/types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](/reference/graphql/2-4-6/types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -668,13 +662,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](/reference/graphql/2-4-6/types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -708,13 +702,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](/reference/graphql/2-4-6/types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -748,14 +742,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -799,7 +793,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } } @@ -812,13 +806,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](/reference/graphql/2-4-6/types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -852,13 +846,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](/reference/graphql/2-4-6/types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -892,13 +886,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | | #### Example @@ -917,7 +911,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -932,13 +926,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](/reference/graphql/2-4-6/types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](/reference/graphql/2-4-6/types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -972,13 +966,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-6/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-6/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1022,13 +1016,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](/reference/graphql/2-4-6/types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1048,7 +1042,7 @@ mutation assignCompareListToCustomer($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -1058,7 +1052,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": true + "result": false } } } @@ -1070,13 +1064,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -1140,7 +1134,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -1161,16 +1155,16 @@ 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": true, + "id": 4, + "is_virtual": false, "items": [CartItemInterface], "prices": CartPrices, "printed_card_included": false, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1182,13 +1176,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-6/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-6/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1232,14 +1226,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/2-4-6/types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | +| `currentPassword` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's updated password. | #### Example @@ -1347,8 +1341,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "abc123", - "newPassword": "abc123" + "currentPassword": "xyz789", + "newPassword": "xyz789" } ``` @@ -1362,19 +1356,19 @@ mutation changeCustomerPassword( "allow_remote_shopping_assistance": false, "compare_list": CompareList, "created_at": "abc123", - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", "default_shipping": "abc123", - "dob": "abc123", + "dob": "xyz789", "email": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group_id": 987, "id": 987, - "is_subscribed": true, - "job_title": "abc123", + "is_subscribed": false, + "job_title": "xyz789", "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, @@ -1393,9 +1387,9 @@ mutation changeCustomerPassword( "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, - "suffix": "xyz789", - "taxvat": "abc123", + "structure_id": "4", + "suffix": "abc123", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", "wishlist": Wishlist, @@ -1412,13 +1406,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](/reference/graphql/2-4-6/types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1446,7 +1440,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": false} + "clearCustomerCart": {"cart": Cart, "status": true} } } ``` @@ -1457,13 +1451,13 @@ mutation clearCustomerCart($cartUid: String!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](/reference/graphql/2-4-6/types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](/reference/graphql/2-4-6/types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1520,15 +1514,15 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](/reference/graphql/2-4-6/types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](/reference/graphql/2-4-6/types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -1556,7 +1550,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", + "sourceRequisitionListUid": 4, "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } @@ -1580,15 +1574,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](/reference/graphql/2-4-6/types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -1648,7 +1642,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) #### Example @@ -1665,7 +1659,7 @@ mutation createBraintreeClientToken { ```json { "data": { - "createBraintreeClientToken": "xyz789" + "createBraintreeClientToken": "abc123" } } ``` @@ -1676,13 +1670,13 @@ mutation createBraintreeClientToken { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](/reference/graphql/2-4-6/types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](/reference/graphql/2-4-6/types-c-e.md#companycreateinput) | | #### Example @@ -1716,13 +1710,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](/reference/graphql/2-4-6/types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](/reference/graphql/2-4-6/types-c-e.md#companyrolecreateinput) | | #### Example @@ -1756,13 +1750,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the authenticated customer's company. -**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](/reference/graphql/2-4-6/types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](/reference/graphql/2-4-6/types-c-e.md#companyteamcreateinput) | | #### Example @@ -1796,13 +1790,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](/reference/graphql/2-4-6/types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](/reference/graphql/2-4-6/types-c-e.md#companyusercreateinput) | | #### Example @@ -1836,13 +1830,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-6/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](/reference/graphql/2-4-6/types-c-e.md#createcomparelistinput) | | #### Example @@ -1876,7 +1870,7 @@ mutation createCompareList($input: CreateCompareListInput) { "data": { "createCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": "4" } @@ -1890,13 +1884,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-6/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](/reference/graphql/2-4-6/types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -1930,13 +1924,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/2-4-6/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](/reference/graphql/2-4-6/types-c-e.md#customeraddressinput) | | #### Example @@ -1990,27 +1984,27 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "data": { "createCustomerAddress": { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], - "customer_id": 123, - "default_billing": true, - "default_shipping": false, + "customer_id": 987, + "default_billing": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", - "id": 987, + "id": 123, "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, - "street": ["abc123"], + "region_id": 123, + "street": ["xyz789"], "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "xyz789" + "telephone": "abc123", + "vat_id": "abc123" } } } @@ -2022,13 +2016,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-6/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](/reference/graphql/2-4-6/types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2062,13 +2056,13 @@ mutation createCustomerV2($input: CustomerCreateInput!) { Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](types-q-s.md#string) +**Response:** [`String`](/reference/graphql/2-4-6/types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](/reference/graphql/2-4-6/types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2089,7 +2083,7 @@ mutation createEmptyCart($input: createEmptyCartInput) { ##### Response ```json -{"data": {"createEmptyCart": "xyz789"}} +{"data": {"createEmptyCart": "abc123"}} ``` @@ -2098,13 +2092,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](/reference/graphql/2-4-6/types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](/reference/graphql/2-4-6/types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2142,13 +2136,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](/reference/graphql/2-4-6/types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](/reference/graphql/2-4-6/types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -2178,11 +2172,11 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "xyz789", - "result": 123, - "result_code": 987, + "response_message": "abc123", + "result": 987, + "result_code": 123, "secure_token": "abc123", - "secure_token_id": "xyz789" + "secure_token_id": "abc123" } } } @@ -2194,13 +2188,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](/reference/graphql/2-4-6/types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](/reference/graphql/2-4-6/types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2242,13 +2236,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](/reference/graphql/2-4-6/types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](/reference/graphql/2-4-6/types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -2286,13 +2280,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -2337,11 +2331,11 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", - "created_by": "abc123", + "created_by": "xyz789", "description": "xyz789", "name": "abc123", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "abc123" } } @@ -2354,13 +2348,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](/reference/graphql/2-4-6/types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](/reference/graphql/2-4-6/types-c-e.md#createrequisitionlistinput) | | #### Example @@ -2400,13 +2394,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](/reference/graphql/2-4-6/types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](/reference/graphql/2-4-6/types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -2440,13 +2434,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](/reference/graphql/2-4-6/types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | | #### Example @@ -2469,7 +2463,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyRole": {"success": true}}} +{"data": {"deleteCompanyRole": {"success": false}}} ``` @@ -2478,13 +2472,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](/reference/graphql/2-4-6/types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | | #### Example @@ -2507,7 +2501,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": true}}} +{"data": {"deleteCompanyTeam": {"success": false}}} ``` @@ -2516,13 +2510,13 @@ mutation deleteCompanyTeam($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/2-4-6/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | | #### Example @@ -2539,7 +2533,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -2554,13 +2548,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](/reference/graphql/2-4-6/types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -2577,13 +2571,13 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response ```json -{"data": {"deleteCompareList": {"result": false}}} +{"data": {"deleteCompareList": {"result": true}}} ``` @@ -2592,7 +2586,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) #### Example @@ -2616,13 +2610,13 @@ mutation deleteCustomer { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -2637,7 +2631,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Variables ```json -{"id": 987} +{"id": 123} ``` ##### Response @@ -2652,13 +2646,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](/reference/graphql/2-4-6/types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](/reference/graphql/2-4-6/types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -2711,13 +2705,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](/reference/graphql/2-4-6/types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -2747,7 +2741,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } } } @@ -2759,13 +2753,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](/reference/graphql/2-4-6/types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-6/types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -2805,13 +2799,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](/reference/graphql/2-4-6/types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -2831,7 +2825,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": 4} +{"requisitionListUid": "4"} ``` ##### Response @@ -2853,14 +2847,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](/reference/graphql/2-4-6/types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -2887,7 +2881,7 @@ mutation deleteRequisitionListItems( ```json { "requisitionListUid": "4", - "requisitionListItemUids": ["4"] + "requisitionListItemUids": [4] } ``` @@ -2909,13 +2903,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](/reference/graphql/2-4-6/types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -2957,14 +2951,14 @@ mutation deleteWishlist($wishlistId: ID!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](types-c-e.md#customertoken) +**Response:** [`CustomerToken`](/reference/graphql/2-4-6/types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's password. | #### Example @@ -2999,7 +2993,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -3011,13 +3005,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](/reference/graphql/2-4-6/types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](/reference/graphql/2-4-6/types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -3055,13 +3049,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](/reference/graphql/2-4-6/types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](/reference/graphql/2-4-6/types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -3095,14 +3089,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | -| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | +| `source_cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -3194,12 +3188,12 @@ 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, + "id": 4, + "is_virtual": false, "items": [CartItemInterface], "prices": CartPrices, "printed_card_included": true, @@ -3217,14 +3211,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-6/types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -3253,7 +3247,10 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": 4, "giftRegistryUid": 4} +{ + "cartUid": "4", + "giftRegistryUid": "4" +} ``` ##### Response @@ -3263,7 +3260,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } } @@ -3276,15 +3273,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](/reference/graphql/2-4-6/types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](/reference/graphql/2-4-6/types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -3315,8 +3312,8 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": 4, + "sourceRequisitionListUid": "4", + "destinationRequisitionListUid": "4", "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -3340,15 +3337,15 @@ mutation moveItemsBetweenRequisitionLists( Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](/reference/graphql/2-4-6/types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -3408,13 +3405,13 @@ mutation moveProductsBetweenWishlists( Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](/reference/graphql/2-4-6/types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](/reference/graphql/2-4-6/types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -3448,13 +3445,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/2-4-6/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](/reference/graphql/2-4-6/types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -3488,13 +3485,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](/reference/graphql/2-4-6/types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](/reference/graphql/2-4-6/types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -3532,13 +3529,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](/reference/graphql/2-4-6/types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](/reference/graphql/2-4-6/types-k-p.md#placepurchaseorderinput) | | #### Example @@ -3578,13 +3575,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/2-4-6/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/2-4-6/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -3615,7 +3612,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "xyz789" } } @@ -3628,13 +3625,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-6/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-6/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -3678,13 +3675,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/2-4-6/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](/reference/graphql/2-4-6/types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -3718,13 +3715,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](/reference/graphql/2-4-6/types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](/reference/graphql/2-4-6/types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -3758,13 +3755,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](/reference/graphql/2-4-6/types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -3796,14 +3793,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](/reference/graphql/2-4-6/types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -3828,7 +3825,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": 4, "itemsUid": ["4"]} +{"giftRegistryUid": "4", "itemsUid": [4]} ``` ##### Response @@ -3849,14 +3846,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-6/types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -3883,7 +3880,7 @@ mutation removeGiftRegistryRegistrants( ```json { "giftRegistryUid": "4", - "registrantsUid": [4] + "registrantsUid": ["4"] } ``` @@ -3905,13 +3902,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](/reference/graphql/2-4-6/types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](/reference/graphql/2-4-6/types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -3945,13 +3942,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](/reference/graphql/2-4-6/types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](/reference/graphql/2-4-6/types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -3991,13 +3988,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove products from the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-6/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](/reference/graphql/2-4-6/types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -4033,7 +4030,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -4045,14 +4042,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](/reference/graphql/2-4-6/types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -4102,13 +4099,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](/reference/graphql/2-4-6/types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](/reference/graphql/2-4-6/types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -4142,13 +4139,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](/reference/graphql/2-4-6/types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | | #### Example @@ -4182,13 +4179,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](/reference/graphql/2-4-6/types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](/reference/graphql/2-4-6/types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -4222,13 +4219,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](/reference/graphql/2-4-6/types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](types-q-s.md#string) | | +| `orderNumber` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -4250,7 +4247,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "abc123"} +{"orderNumber": "xyz789"} ``` ##### Response @@ -4272,13 +4269,13 @@ mutation reorderItems($orderNumber: String!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](/reference/graphql/2-4-6/types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](/reference/graphql/2-4-6/types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -4316,13 +4313,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's email address. | #### Example @@ -4337,7 +4334,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -4352,13 +4349,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/2-4-6/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](/reference/graphql/2-4-6/types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -4402,15 +4399,15 @@ mutation requestReturn($input: RequestReturnInput!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's new password. | #### Example @@ -4434,7 +4431,7 @@ mutation resetPassword( ```json { - "email": "xyz789", + "email": "abc123", "resetPasswordToken": "xyz789", "newPassword": "xyz789" } @@ -4443,7 +4440,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": true}} +{"data": {"resetPassword": false}} ``` @@ -4452,7 +4449,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](/reference/graphql/2-4-6/types-q-s.md#revokecustomertokenoutput) #### Example @@ -4469,7 +4466,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": true}}} +{"data": {"revokeCustomerToken": {"result": false}}} ``` @@ -4478,13 +4475,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](/reference/graphql/2-4-6/types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](/reference/graphql/2-4-6/types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -4528,13 +4525,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](/reference/graphql/2-4-6/types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](/reference/graphql/2-4-6/types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -4574,13 +4571,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](/reference/graphql/2-4-6/types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](/reference/graphql/2-4-6/types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -4614,13 +4611,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](/reference/graphql/2-4-6/types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](/reference/graphql/2-4-6/types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -4654,13 +4651,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](/reference/graphql/2-4-6/types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](/reference/graphql/2-4-6/types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -4694,13 +4691,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -4740,13 +4737,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -4786,13 +4783,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -4832,13 +4829,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](/reference/graphql/2-4-6/types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -4882,13 +4879,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/2-4-6/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](/reference/graphql/2-4-6/types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -4926,13 +4923,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](/reference/graphql/2-4-6/types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](/reference/graphql/2-4-6/types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -4966,13 +4963,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](/reference/graphql/2-4-6/types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](/reference/graphql/2-4-6/types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -5006,13 +5003,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](/reference/graphql/2-4-6/types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](/reference/graphql/2-4-6/types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -5046,15 +5043,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](/reference/graphql/2-4-6/types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](/reference/graphql/2-4-6/types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](/reference/graphql/2-4-6/types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -5089,7 +5086,7 @@ mutation shareGiftRegistry( ##### Response ```json -{"data": {"shareGiftRegistry": {"is_shared": false}}} +{"data": {"shareGiftRegistry": {"is_shared": true}}} ``` @@ -5098,13 +5095,13 @@ mutation shareGiftRegistry( Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](/reference/graphql/2-4-6/types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -5121,7 +5118,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -5136,13 +5133,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](/reference/graphql/2-4-6/types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](/reference/graphql/2-4-6/types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -5176,13 +5173,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](/reference/graphql/2-4-6/types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](/reference/graphql/2-4-6/types-c-e.md#companyupdateinput) | | #### Example @@ -5216,13 +5213,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](/reference/graphql/2-4-6/types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](/reference/graphql/2-4-6/types-c-e.md#companyroleupdateinput) | | #### Example @@ -5256,13 +5253,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team. -**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](/reference/graphql/2-4-6/types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](/reference/graphql/2-4-6/types-c-e.md#companystructureupdateinput) | | #### Example @@ -5296,13 +5293,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](/reference/graphql/2-4-6/types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](/reference/graphql/2-4-6/types-c-e.md#companyteamupdateinput) | | #### Example @@ -5336,13 +5333,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](/reference/graphql/2-4-6/types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](/reference/graphql/2-4-6/types-c-e.md#companyuserupdateinput) | | #### Example @@ -5376,13 +5373,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-6/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](/reference/graphql/2-4-6/types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -5416,14 +5413,14 @@ mutation updateCustomer($input: CustomerInput!) { Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/2-4-6/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](/reference/graphql/2-4-6/types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -5473,7 +5470,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 123, "input": CustomerAddressInput} +{"id": 987, "input": CustomerAddressInput} ``` ##### Response @@ -5483,25 +5480,25 @@ mutation updateCustomerAddress( "data": { "updateCustomerAddress": { "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], - "customer_id": 123, - "default_billing": true, + "customer_id": 987, + "default_billing": false, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", + "fax": "xyz789", + "firstname": "xyz789", "id": 123, "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["xyz789"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", "vat_id": "xyz789" } @@ -5515,14 +5512,14 @@ mutation updateCustomerAddress( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-6/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's password. | #### Example @@ -5548,7 +5545,7 @@ mutation updateCustomerEmail( ```json { - "email": "abc123", + "email": "xyz789", "password": "xyz789" } ``` @@ -5565,13 +5562,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-6/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](/reference/graphql/2-4-6/types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -5605,14 +5602,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](/reference/graphql/2-4-6/types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](/reference/graphql/2-4-6/types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -5638,7 +5635,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "giftRegistry": UpdateGiftRegistryInput } ``` @@ -5659,14 +5656,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](/reference/graphql/2-4-6/types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](/reference/graphql/2-4-6/types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -5715,14 +5712,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-6/types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](/reference/graphql/2-4-6/types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -5771,13 +5768,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](/reference/graphql/2-4-6/types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](/reference/graphql/2-4-6/types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -5817,14 +5814,14 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](/reference/graphql/2-4-6/types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -5877,13 +5874,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-6/types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -5927,13 +5924,13 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "abc123", - "description": "xyz789", - "name": "abc123", + "created_at": "xyz789", + "created_by": "xyz789", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -5945,14 +5942,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](/reference/graphql/2-4-6/types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](/reference/graphql/2-4-6/types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -5978,7 +5975,7 @@ mutation updateRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "input": UpdateRequisitionListInput } ``` @@ -6001,14 +5998,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](/reference/graphql/2-4-6/types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](/reference/graphql/2-4-6/types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -6034,7 +6031,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItems": [ UpdateRequisitionListItemsInput ] @@ -6059,15 +6056,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](/reference/graphql/2-4-6/types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](/reference/graphql/2-4-6/types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -6095,8 +6092,8 @@ mutation updateWishlist( ```json { - "wishlistId": "4", - "name": "xyz789", + "wishlistId": 4, + "name": "abc123", "visibility": "PUBLIC" } ``` @@ -6107,8 +6104,8 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "xyz789", - "uid": "4", + "name": "abc123", + "uid": 4, "visibility": "PUBLIC" } } @@ -6121,13 +6118,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](/reference/graphql/2-4-6/types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](/reference/graphql/2-4-6/types-t-z.md#validatepurchaseordersinput) | | #### Example 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 5c234a846..61dc30309 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) +**Response:** [`[StoreConfig]`](/reference/graphql/2-4-6/types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -172,36 +172,36 @@ query availableStores($useCurrentGroup: Boolean) { "availableStores": [ { "absolute_footer": "abc123", - "allow_gift_receipt": "abc123", + "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "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, + "allow_printed_card": "abc123", + "autocomplete_on_storefront": false, "base_currency_code": "abc123", - "base_link_url": "xyz789", + "base_link_url": "abc123", "base_media_url": "abc123", - "base_static_url": "abc123", + "base_static_url": "xyz789", "base_url": "abc123", "braintree_cc_vault_active": "xyz789", - "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", - "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": false, + "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_max_order_total": "abc123", "check_money_order_min_order_total": "abc123", - "check_money_order_new_order_status": "xyz789", + "check_money_order_new_order_status": "abc123", "check_money_order_payment_from_specific_countries": "xyz789", "check_money_order_send_check_to": "xyz789", "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", - "cms_home_page": "xyz789", + "cms_home_page": "abc123", "cms_no_cookies": "abc123", "cms_no_route": "xyz789", "code": "xyz789", @@ -209,19 +209,19 @@ query availableStores($useCurrentGroup: Boolean) { "copyright": "abc123", "default_description": "xyz789", "default_display_currency_code": "xyz789", - "default_keywords": "abc123", - "default_title": "xyz789", + "default_keywords": "xyz789", + "default_title": "abc123", "demonotice": 987, - "enable_multiple_wishlists": "xyz789", - "front": "xyz789", + "enable_multiple_wishlists": "abc123", + "front": "abc123", "grid_per_page": 987, "grid_per_page_values": "abc123", - "head_includes": "xyz789", + "head_includes": "abc123", "head_shortcut_icon": "xyz789", "header_logo_src": "xyz789", - "id": 123, + "id": 987, "is_default_store": true, - "is_default_store_group": true, + "is_default_store_group": false, "is_negotiable_quote_active": false, "is_requisition_list_active": "xyz789", "list_mode": "xyz789", @@ -229,63 +229,63 @@ query availableStores($useCurrentGroup: Boolean) { "list_per_page_values": "xyz789", "locale": "abc123", "logo_alt": "xyz789", - "logo_height": 987, - "logo_width": 987, + "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": "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": "abc123", "magento_reward_points_invitation_customer_limit": "xyz789", - "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_newsletter": "xyz789", "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "abc123", - "magento_reward_points_review": "abc123", + "magento_reward_points_register": "xyz789", + "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", "magento_wishlist_general_is_enabled": "abc123", "maximum_number_of_wishlists": "abc123", - "minimum_password_length": "xyz789", - "no_route": "xyz789", - "payment_payflowpro_cc_vault_active": "abc123", + "minimum_password_length": "abc123", + "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": "abc123", "product_url_suffix": "abc123", - "required_character_classes_number": "xyz789", - "returns_enabled": "abc123", + "required_character_classes_number": "abc123", + "returns_enabled": "xyz789", "root_category_id": 123, "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "abc123", - "sales_printed_card": "abc123", + "sales_printed_card": "xyz789", "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", + "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_name": "xyz789", "store_sort_order": 123, - "timezone": "abc123", + "timezone": "xyz789", "title_prefix": "abc123", - "title_separator": "abc123", - "title_suffix": "abc123", + "title_separator": "xyz789", + "title_suffix": "xyz789", "use_store_in_url": false, - "website_code": 4, - "website_id": 123, + "website_code": "4", + "website_id": 987, "website_name": "xyz789", - "weight_unit": "xyz789", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": false, + "weight_unit": "abc123", + "welcome": "xyz789", + "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_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } @@ -300,13 +300,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](types-c-e.md#cart) +**Response:** [`Cart`](/reference/graphql/2-4-6/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -397,7 +397,7 @@ query cart($cart_id: String!) { "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 @@ -412,15 +412,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](types-c-e.md#categoryresult) +**Response:** [`CategoryResult`](/reference/graphql/2-4-6/types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/2-4-6/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -466,7 +466,7 @@ query categories( "categories": { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -482,13 +482,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](types-c-e.md#categorytree) +**Response:** [`CategoryTree`](/reference/graphql/2-4-6/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -549,7 +549,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response @@ -558,42 +558,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": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "abc123", + "created_at": "xyz789", "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", + "default_sort_by": "abc123", "description": "abc123", - "display_mode": "abc123", - "filter_price_range": 987.65, + "display_mode": "xyz789", + "filter_price_range": 123.45, "id": 123, "image": "xyz789", "include_in_menu": 987, "is_anchor": 123, "landing_page": 987, - "level": 987, + "level": 123, "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", "name": "xyz789", "path": "xyz789", "path_in_store": "abc123", "position": 123, - "product_count": 123, + "product_count": 987, "products": CategoryProducts, - "redirect_code": 123, - "relative_url": "abc123", - "staged": true, + "redirect_code": 987, + "relative_url": "xyz789", + "staged": false, "type": "CMS_PAGE", "uid": "4", "updated_at": "abc123", - "url_key": "xyz789", - "url_path": "xyz789", + "url_key": "abc123", + "url_path": "abc123", "url_suffix": "abc123" } } @@ -610,15 +610,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) +**Response:** [`[CategoryTree]`](/reference/graphql/2-4-6/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/2-4-6/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -701,43 +701,43 @@ query categoryList( "data": { "categoryList": [ { - "automatic_sorting": "xyz789", - "available_sort_by": ["abc123"], + "automatic_sorting": "abc123", + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "abc123", + "created_at": "xyz789", "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", "description": "abc123", - "display_mode": "xyz789", - "filter_price_range": 123.45, + "display_mode": "abc123", + "filter_price_range": 987.65, "id": 123, - "image": "abc123", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 123, + "image": "xyz789", + "include_in_menu": 987, + "is_anchor": 123, + "landing_page": 987, "level": 123, "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "xyz789", - "path": "abc123", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "abc123", + "path": "xyz789", "path_in_store": "xyz789", - "position": 123, - "product_count": 987, + "position": 987, + "product_count": 123, "products": CategoryProducts, - "redirect_code": 123, + "redirect_code": 987, "relative_url": "xyz789", - "staged": false, + "staged": true, "type": "CMS_PAGE", "uid": "4", "updated_at": "abc123", "url_key": "abc123", - "url_path": "abc123", - "url_suffix": "abc123" + "url_path": "xyz789", + "url_suffix": "xyz789" } ] } @@ -750,7 +750,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](/reference/graphql/2-4-6/types-c-e.md#checkoutagreement) #### Example @@ -778,12 +778,12 @@ query checkoutAgreements { "checkoutAgreements": [ { "agreement_id": 987, - "checkbox_text": "xyz789", + "checkbox_text": "abc123", "content": "abc123", "content_height": "abc123", "is_html": false, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ] } @@ -796,13 +796,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) +**Response:** [`CmsBlocks`](/reference/graphql/2-4-6/types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -836,14 +836,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](types-c-e.md#cmspage) +**Response:** [`CmsPage`](/reference/graphql/2-4-6/types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -877,7 +877,7 @@ query cmsPage( ##### Variables ```json -{"id": 987, "identifier": "xyz789"} +{"id": 123, "identifier": "xyz789"} ``` ##### Response @@ -887,15 +887,15 @@ query cmsPage( "data": { "cmsPage": { "content": "abc123", - "content_heading": "xyz789", + "content_heading": "abc123", "identifier": "abc123", "meta_description": "xyz789", "meta_keywords": "xyz789", "meta_title": "xyz789", - "page_layout": "xyz789", + "page_layout": "abc123", "redirect_code": 123, "relative_url": "xyz789", - "title": "abc123", + "title": "xyz789", "type": "CMS_PAGE", "url_key": "abc123" } @@ -909,7 +909,7 @@ query cmsPage( Return detailed information about the authenticated customer's company. -**Response:** [`Company`](types-c-e.md#company) +**Response:** [`Company`](/reference/graphql/2-4-6/types-c-e.md#company) #### Example @@ -979,8 +979,8 @@ query company { "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "abc123", - "name": "abc123", - "payment_methods": ["xyz789"], + "name": "xyz789", + "payment_methods": ["abc123"], "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, @@ -989,7 +989,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } } } @@ -1001,13 +1001,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-6/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1043,7 +1043,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -1055,7 +1055,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](types-c-e.md#country) +**Response:** [`[Country]`](/reference/graphql/2-4-6/types-c-e.md#country) #### Example @@ -1086,9 +1086,9 @@ query countries { "available_regions": [Region], "full_name_english": "abc123", "full_name_locale": "abc123", - "id": "xyz789", + "id": "abc123", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } ] } @@ -1101,13 +1101,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](types-c-e.md#country) +**Response:** [`Country`](/reference/graphql/2-4-6/types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](types-q-s.md#string) | | +| `id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -1145,7 +1145,7 @@ query country($id: String) { "full_name_locale": "abc123", "id": "xyz789", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } } } @@ -1157,7 +1157,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](types-c-e.md#currency) +**Response:** [`Currency`](/reference/graphql/2-4-6/types-c-e.md#currency) #### Example @@ -1187,13 +1187,13 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", - "default_display_currecy_code": "abc123", + "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } @@ -1207,13 +1207,13 @@ query currency { Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](/reference/graphql/2-4-6/types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](/reference/graphql/2-4-6/types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1251,7 +1251,7 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Return detailed information about a customer account. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/2-4-6/types-c-e.md#customer) #### Example @@ -1361,16 +1361,16 @@ query customer { "created_at": "abc123", "date_of_birth": "xyz789", "default_billing": "abc123", - "default_shipping": "abc123", - "dob": "xyz789", - "email": "abc123", - "firstname": "abc123", - "gender": 987, + "default_shipping": "xyz789", + "dob": "abc123", + "email": "xyz789", + "firstname": "xyz789", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 123, + "group_id": 987, "id": 123, - "is_subscribed": false, + "is_subscribed": true, "job_title": "abc123", "lastname": "abc123", "middlename": "xyz789", @@ -1381,7 +1381,7 @@ query customer { "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, + "purchase_orders_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1390,7 +1390,7 @@ query customer { "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, + "structure_id": "4", "suffix": "abc123", "taxvat": "xyz789", "team": CompanyTeam, @@ -1409,7 +1409,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) #### Example @@ -1486,7 +1486,7 @@ query customerCart { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, @@ -1509,7 +1509,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](/reference/graphql/2-4-6/types-c-e.md#customerdownloadableproducts) #### Example @@ -1545,7 +1545,7 @@ query customerDownloadableProducts { Use the `customer` query instead. -**Response:** [`CustomerOrders`](types-c-e.md#customerorders) +**Response:** [`CustomerOrders`](/reference/graphql/2-4-6/types-c-e.md#customerorders) #### Example @@ -1585,7 +1585,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](/reference/graphql/2-4-6/types-c-e.md#customerpaymenttokens) #### Example @@ -1617,15 +1617,15 @@ query customerPaymentTokens { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) +**Response:** [`DynamicBlocks!`](/reference/graphql/2-4-6/types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](/reference/graphql/2-4-6/types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -1671,7 +1671,7 @@ query dynamicBlocks( "dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -1683,13 +1683,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) +**Response:** [`HostedProUrl`](/reference/graphql/2-4-6/types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](/reference/graphql/2-4-6/types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -1715,7 +1715,7 @@ query getHostedProUrl($input: HostedProUrlInput!) { { "data": { "getHostedProUrl": { - "secure_form_url": "xyz789" + "secure_form_url": "abc123" } } } @@ -1727,13 +1727,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) +**Response:** [`PayflowLinkToken`](/reference/graphql/2-4-6/types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](/reference/graphql/2-4-6/types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -1763,7 +1763,7 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "xyz789", + "paypal_url": "abc123", "secure_token": "abc123", "secure_token_id": "xyz789" } @@ -1777,13 +1777,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/2-4-6/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/2-4-6/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -1827,13 +1827,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) +**Response:** [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -1884,10 +1884,10 @@ query giftRegistry($giftRegistryUid: ID!) { "dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], "message": "abc123", - "owner_name": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, @@ -1905,13 +1905,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-6/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The registrant's email. | #### Example @@ -1944,10 +1944,10 @@ query giftRegistryEmailSearch($email: String!) { "giftRegistryEmailSearch": [ { "event_date": "abc123", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", + "location": "xyz789", + "name": "abc123", "type": "xyz789" } ] @@ -1961,13 +1961,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-6/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -1989,7 +1989,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -2000,8 +2000,8 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "giftRegistryIdSearch": [ { "event_date": "abc123", - "event_title": "abc123", - "gift_registry_uid": 4, + "event_title": "xyz789", + "gift_registry_uid": "4", "location": "xyz789", "name": "xyz789", "type": "xyz789" @@ -2017,15 +2017,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-6/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | +| `firstName` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2056,7 +2056,7 @@ query giftRegistryTypeSearch( ```json { - "firstName": "xyz789", + "firstName": "abc123", "lastName": "abc123", "giftRegistryTypeUid": "4" } @@ -2069,11 +2069,11 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "abc123", "gift_registry_uid": 4, - "location": "abc123", - "name": "xyz789", + "location": "xyz789", + "name": "abc123", "type": "xyz789" } ] @@ -2087,7 +2087,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) +**Response:** [`[GiftRegistryType]`](/reference/graphql/2-4-6/types-f-i.md#giftregistrytype) #### Example @@ -2129,13 +2129,13 @@ query giftRegistryTypes { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](/reference/graphql/2-4-6/types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -2152,7 +2152,7 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2167,13 +2167,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](/reference/graphql/2-4-6/types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -2190,13 +2190,13 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} ``` @@ -2205,13 +2205,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](/reference/graphql/2-4-6/types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](types-q-s.md#string) | | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -2228,7 +2228,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "abc123"} +{"name": "xyz789"} ``` ##### Response @@ -2243,13 +2243,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](/reference/graphql/2-4-6/types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -2281,13 +2281,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](/reference/graphql/2-4-6/types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to check. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address to check. | #### Example @@ -2310,7 +2310,7 @@ query isEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": true}}} +{"data": {"isEmailAvailable": {"is_email_available": false}}} ``` @@ -2319,13 +2319,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) +**Response:** [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | | #### Example @@ -2392,9 +2392,9 @@ query negotiableQuote($uid: ID!) { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "email": "xyz789", + "email": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "abc123", "prices": CartPrices, @@ -2403,9 +2403,9 @@ query negotiableQuote($uid: ID!) { NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -2417,16 +2417,16 @@ query negotiableQuote($uid: ID!) { Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](/reference/graphql/2-4-6/types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](/reference/graphql/2-4-6/types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](/reference/graphql/2-4-6/types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -2479,7 +2479,7 @@ query negotiableQuotes( "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -2491,18 +2491,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) +**Response:** [`PickupLocations`](/reference/graphql/2-4-6/types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](/reference/graphql/2-4-6/types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](/reference/graphql/2-4-6/types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](/reference/graphql/2-4-6/types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](/reference/graphql/2-4-6/types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -2569,7 +2569,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](/reference/graphql/2-4-6/types-k-p.md#productreviewratingsmetadata) #### Example @@ -2603,17 +2603,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](types-k-p.md#products) +**Response:** [`Products`](/reference/graphql/2-4-6/types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](/reference/graphql/2-4-6/types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](/reference/graphql/2-4-6/types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -2681,7 +2681,7 @@ query products( "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 123 + "total_count": 987 } } } @@ -2693,13 +2693,13 @@ query products( Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) +**Response:** [`RoutableInterface`](/reference/graphql/2-4-6/types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -2718,7 +2718,7 @@ query route($url: String!) { ##### Variables ```json -{"url": "abc123"} +{"url": "xyz789"} ``` ##### Response @@ -2741,7 +2741,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](types-q-s.md#storeconfig) +**Response:** [`StoreConfig`](/reference/graphql/2-4-6/types-q-s.md#storeconfig) #### Example @@ -2880,122 +2880,122 @@ query storeConfig { "data": { "storeConfig": { "absolute_footer": "xyz789", - "allow_gift_receipt": "abc123", + "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "xyz789", - "allow_order": "abc123", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": false, - "base_currency_code": "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": "abc123", - "base_static_url": "abc123", - "base_url": "abc123", - "braintree_cc_vault_active": "xyz789", + "base_media_url": "xyz789", + "base_static_url": "xyz789", + "base_url": "xyz789", + "braintree_cc_vault_active": "abc123", "cart_gift_wrapping": "xyz789", "cart_printed_card": "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": true, "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "abc123", - "check_money_order_max_order_total": "xyz789", + "check_money_order_max_order_total": "abc123", "check_money_order_min_order_total": "xyz789", - "check_money_order_new_order_status": "abc123", - "check_money_order_payment_from_specific_countries": "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": "xyz789", - "cms_home_page": "abc123", + "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", "cms_no_route": "xyz789", "code": "abc123", - "configurable_thumbnail_source": "xyz789", + "configurable_thumbnail_source": "abc123", "copyright": "xyz789", - "default_description": "xyz789", - "default_display_currency_code": "abc123", + "default_description": "abc123", + "default_display_currency_code": "xyz789", "default_keywords": "abc123", "default_title": "abc123", - "demonotice": 123, + "demonotice": 987, "enable_multiple_wishlists": "abc123", "front": "xyz789", - "grid_per_page": 987, - "grid_per_page_values": "abc123", + "grid_per_page": 123, + "grid_per_page_values": "xyz789", "head_includes": "xyz789", - "head_shortcut_icon": "xyz789", - "header_logo_src": "xyz789", + "head_shortcut_icon": "abc123", + "header_logo_src": "abc123", "id": 987, - "is_default_store": false, + "is_default_store": true, "is_default_store_group": true, "is_negotiable_quote_active": true, "is_requisition_list_active": "abc123", - "list_mode": "xyz789", - "list_per_page": 123, - "list_per_page_values": "xyz789", + "list_mode": "abc123", + "list_per_page": 987, + "list_per_page_values": "abc123", "locale": "abc123", - "logo_alt": "abc123", - "logo_height": 987, - "logo_width": 987, - "magento_reward_general_is_enabled": "xyz789", + "logo_alt": "xyz789", + "logo_height": 123, + "logo_width": 123, + "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": "xyz789", - "magento_reward_points_invitation_customer": "xyz789", + "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": "abc123", + "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": "xyz789", - "maximum_number_of_wishlists": "abc123", - "minimum_password_length": "abc123", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "abc123", + "maximum_number_of_wishlists": "xyz789", + "minimum_password_length": "xyz789", "no_route": "xyz789", "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "xyz789", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "xyz789", - "product_url_suffix": "xyz789", + "product_url_suffix": "abc123", "required_character_classes_number": "xyz789", - "returns_enabled": "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": "abc123", - "secure_base_link_url": "abc123", + "sales_printed_card": "xyz789", + "secure_base_link_url": "xyz789", "secure_base_media_url": "xyz789", - "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", + "secure_base_static_url": "xyz789", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "show_cms_breadcrumbs": 123, + "show_cms_breadcrumbs": 987, "store_code": 4, - "store_group_code": "4", - "store_group_name": "abc123", + "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": "abc123", + "store_sort_order": 987, + "timezone": "abc123", + "title_prefix": "xyz789", + "title_separator": "xyz789", + "title_suffix": "xyz789", "use_store_in_url": true, "website_code": 4, "website_id": 123, - "website_name": "abc123", + "website_name": "xyz789", "weight_unit": "xyz789", - "welcome": "xyz789", + "welcome": "abc123", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "xyz789", + "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" } } } @@ -3011,13 +3011,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](types-c-e.md#entityurl) +**Response:** [`EntityUrl`](/reference/graphql/2-4-6/types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3048,11 +3048,11 @@ query urlResolver($url: String!) { { "data": { "urlResolver": { - "canonical_url": "xyz789", + "canonical_url": "abc123", "entity_uid": "4", - "id": 987, - "redirectCode": 123, - "relative_url": "xyz789", + "id": 123, + "redirectCode": 987, + "relative_url": "abc123", "type": "CMS_PAGE" } } @@ -3069,7 +3069,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) +**Response:** [`WishlistOutput`](/reference/graphql/2-4-6/types-t-z.md#wishlistoutput) #### Example @@ -3097,9 +3097,9 @@ query wishlist { "wishlist": { "items": [WishlistItem], "items_count": 987, - "name": "xyz789", + "name": "abc123", "sharing_code": "abc123", - "updated_at": "abc123" + "updated_at": "xyz789" } } } 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 index dd634640c..1fdbb3d81 100644 --- 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 @@ -8,7 +8,7 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example @@ -30,7 +30,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -48,14 +48,14 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](/reference/graphql/2-4-6/types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [ConfigurableProductCartItemInput] } ``` @@ -70,7 +70,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -86,14 +86,14 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](/reference/graphql/2-4-6/types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [DownloadableProductCartItemInput] } ``` @@ -108,7 +108,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -126,10 +126,10 @@ Defines a new registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-6/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the registrant. | #### Example @@ -138,8 +138,8 @@ Defines a new registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", - "firstname": "abc123", + "email": "abc123", + "firstname": "xyz789", "lastname": "abc123" } ``` @@ -154,7 +154,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -172,8 +172,8 @@ Contains details about the cart after adding products to it. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]!`](/reference/graphql/2-4-6/types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -194,13 +194,13 @@ Contains products to add to an existing compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": [4], "uid": 4} +{"products": [4], "uid": "4"} ``` @@ -213,7 +213,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -231,8 +231,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -253,15 +253,15 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { - "comment": "abc123", - "purchase_order_uid": "4" + "comment": "xyz789", + "purchase_order_uid": 4 } ``` @@ -275,7 +275,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](/reference/graphql/2-4-6/types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -293,16 +293,16 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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", + "cart_id": "abc123", + "purchase_order_uid": 4, "replace_existing_cart_items": true } ``` @@ -317,7 +317,7 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A description of the error. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example @@ -359,7 +359,7 @@ Output of the request to add items in a requisition list to the cart. | 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`](types-c-e.md#cart) | The cart after adding requisition list items. | +| `cart` - [`Cart`](/reference/graphql/2-4-6/types-c-e.md#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 @@ -370,7 +370,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } ``` @@ -384,16 +384,13 @@ Defines a return comment. | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `comment_text` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example ```json -{ - "comment_text": "abc123", - "return_uid": "4" -} +{"comment_text": "abc123", "return_uid": 4} ``` @@ -406,7 +403,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | The modified return. | +| `return` - [`Return`](/reference/graphql/2-4-6/types-q-s.md#return) | The modified return. | #### Example @@ -424,17 +421,17 @@ Defines tracking information to be added to the return. | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | +| `carrier_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { - "carrier_uid": 4, - "return_uid": "4", - "tracking_number": "abc123" + "carrier_uid": "4", + "return_uid": 4, + "tracking_number": "xyz789" } ``` @@ -448,8 +445,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](/reference/graphql/2-4-6/types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](/reference/graphql/2-4-6/types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -470,14 +467,14 @@ Defines the simple and group products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](/reference/graphql/2-4-6/types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [SimpleProductCartItemInput] } ``` @@ -492,7 +489,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -510,8 +507,8 @@ Defines the virtual products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](/reference/graphql/2-4-6/types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example @@ -532,7 +529,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -550,9 +547,9 @@ Contains the resultant wish list and any error information. | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](/reference/graphql/2-4-6/types-t-z.md#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!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -576,19 +573,19 @@ Contains information for each filterable option (such as price, category `UID`, | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | -| `label` - [`String`](types-q-s.md#string) | The aggregation display name. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The aggregation display name. | | `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example ```json { - "attribute_code": "xyz789", - "count": 123, - "label": "abc123", + "attribute_code": "abc123", + "count": 987, + "label": "xyz789", "options": [AggregationOption], "position": 987 } @@ -604,9 +601,9 @@ An implementation of `AggregationOptionInterface`. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example @@ -628,9 +625,9 @@ Defines aggregation option fields. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -643,7 +640,7 @@ Defines aggregation option fields. ```json { "count": 987, - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -663,7 +660,7 @@ Filter category aggregations in layered navigation. #### Example ```json -{"includeDirectChildrenOnly": true} +{"includeDirectChildrenOnly": false} ``` @@ -694,7 +691,7 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example @@ -712,10 +709,10 @@ Contains an applied gift card with applied and remaining balance. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `applied_balance` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -724,7 +721,7 @@ Contains an applied gift card with applied and remaining balance. "applied_balance": Money, "code": "abc123", "current_balance": Money, - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -738,8 +735,8 @@ Contains the applied and current balances. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](types-k-p.md#money) | The current balance remaining on store credit. | +| `applied_balance` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#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 @@ -748,7 +745,7 @@ Contains the applied and current balances. { "applied_balance": Money, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -762,15 +759,15 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A valid coupon code. | #### Example ```json { "cart_id": "abc123", - "coupon_code": "xyz789" + "coupon_code": "abc123" } ``` @@ -784,7 +781,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -802,14 +799,14 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_card_code": "abc123" } ``` @@ -824,7 +821,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -842,7 +839,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -860,7 +857,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -878,7 +875,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -896,13 +893,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | Input Field | Description | |-------------|-------------| -| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | -| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| `radius` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 123, "search_term": "abc123"} +{"radius": 987, "search_term": "abc123"} ``` @@ -915,13 +912,13 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](/reference/graphql/2-4-6/types-c-e.md#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} +{"compare_list": CompareList, "result": true} ``` @@ -934,12 +931,12 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The data type of the attribute. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `attribute_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](/reference/graphql/2-4-6/types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example @@ -948,8 +945,8 @@ Contains details about the attribute, including the code and type. "attribute_code": "xyz789", "attribute_options": [AttributeOption], "attribute_type": "xyz789", - "entity_type": "xyz789", - "input_type": "abc123", + "entity_type": "abc123", + "input_type": "xyz789", "storefront_properties": StorefrontProperties } ``` @@ -964,15 +961,15 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `attribute_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of entity that defines the attribute. | #### Example ```json { - "attribute_code": "xyz789", - "entity_type": "abc123" + "attribute_code": "abc123", + "entity_type": "xyz789" } ``` @@ -986,8 +983,8 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The attribute option value. | #### Example @@ -1008,8 +1005,8 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](/reference/graphql/2-4-6/types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Currency symbol, for example $. | #### Example @@ -1027,17 +1024,17 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](types-q-s.md#string) | The payment method title. | +| `title` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The payment method title. | #### Example ```json { "code": "abc123", - "is_deferred": false, - "title": "xyz789" + "is_deferred": true, + "title": "abc123" } ``` @@ -1051,29 +1048,29 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#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`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | -| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | -| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `base_amount` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example ```json { "amount": Money, - "available": true, + "available": false, "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "abc123", - "error_message": "xyz789", - "method_code": "abc123", - "method_title": "abc123", + "carrier_code": "xyz789", + "carrier_title": "xyz789", + "error_message": "abc123", + "method_code": "xyz789", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1107,8 +1104,8 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `address` - [`CartAddressInput`](/reference/graphql/2-4-6/types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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. | @@ -1117,7 +1114,7 @@ Defines the billing address. ```json { "address": CartAddressInput, - "customer_address_id": 123, + "customer_address_id": 987, "same_as_shipping": true, "use_for_shipping": false } @@ -1133,34 +1130,34 @@ Contains details about the billing address. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | -| `customer_notes` - [`String`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/2-4-6/types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `customer_notes` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the customer or guest. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`CartAddressRegion`](/reference/graphql/2-4-6/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country": CartAddressCountry, "customer_notes": "xyz789", "firstname": "xyz789", "lastname": "abc123", - "postcode": "xyz789", + "postcode": "abc123", "region": CartAddressRegion, "street": ["xyz789"], - "telephone": "abc123", - "uid": "abc123", + "telephone": "xyz789", + "uid": "xyz789", "vat_id": "xyz789" } ``` @@ -1171,6 +1168,12 @@ Contains details about the billing address. The `Boolean` scalar type represents `true` or `false`. +#### Example + +```json +true +``` + ### BraintreeCcVaultInput @@ -1179,15 +1182,15 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | | -| `public_hash` - [`String!`](types-q-s.md#string) | | +| `device_data` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `public_hash` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example ```json { - "device_data": "abc123", - "public_hash": "xyz789" + "device_data": "xyz789", + "public_hash": "abc123" } ``` @@ -1199,17 +1202,17 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway. | +| `device_data` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-q-s.md#string) | The one-time payment token generated by Braintree payment gateway based on card details. Required field to make sale transaction. | +| `payment_method_nonce` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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": "xyz789", - "is_active_payment_token_enabler": true, - "payment_method_nonce": "xyz789" + "is_active_payment_token_enabler": false, + "payment_method_nonce": "abc123" } ``` @@ -1223,20 +1226,20 @@ Contains details about an individual category that comprises a breadcrumb. | Field Name | Description | |------------|-------------| -| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](types-f-i.md#int) | The category level. | -| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | -| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | +| `category_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The category level. | +| `category_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL path of the category. | #### Example ```json { - "category_id": 123, + "category_id": 987, "category_level": 987, - "category_name": "xyz789", + "category_name": "abc123", "category_uid": 4, "category_url_key": "abc123", "category_url_path": "abc123" @@ -1253,17 +1256,17 @@ An implementation for bundle product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-6/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-6/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1275,11 +1278,11 @@ An implementation for bundle product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", + "id": "abc123", "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" } ``` @@ -1293,14 +1296,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-6/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | #### Example @@ -1308,7 +1311,7 @@ Defines bundle product options for `CreditMemoItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, @@ -1327,14 +1330,14 @@ Defines bundle product options for `InvoiceItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-6/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1342,12 +1345,12 @@ Defines bundle product options for `InvoiceItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -1361,28 +1364,28 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | | `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | -| `title` - [`String`](types-q-s.md#string) | The display name of the item. | -| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example ```json { - "option_id": 987, + "option_id": 123, "options": [BundleItemOption], "position": 987, "price_range": PriceRange, - "required": true, + "required": false, "sku": "abc123", - "title": "abc123", - "type": "xyz789", + "title": "xyz789", + "type": "abc123", "uid": 4 } ``` @@ -1398,32 +1401,32 @@ Defines the characteristics that comprise a specific bundle item and its options | Field Name | Description | |------------|-------------| | `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](types-f-i.md#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-q-s.md#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": false, - "id": 987, - "is_default": true, + "can_change_quantity": true, + "id": 123, + "is_default": false, "label": "xyz789", - "position": 987, + "position": 123, "price": 123.45, "price_type": "FIXED", "product": ProductInterface, - "qty": 123.45, + "qty": 987.65, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -1437,9 +1440,9 @@ Defines the input for a bundle option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array with the chosen value of the option. | #### Example @@ -1447,7 +1450,7 @@ Defines the input for a bundle option. { "id": 123, "quantity": 987.65, - "value": ["abc123"] + "value": ["xyz789"] } ``` @@ -1461,26 +1464,26 @@ Defines bundle product options for `OrderItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-6/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#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]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-6/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-6/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The status of the order item. | #### Example @@ -1488,24 +1491,24 @@ Defines bundle product options for `OrderItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", - "product_url_key": "xyz789", + "product_sku": "abc123", + "product_type": "abc123", + "product_url_key": "abc123", "quantity_canceled": 987.65, "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -1519,132 +1522,132 @@ Defines basic features of a bundle product and contains multiple BundleItems. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `activity` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](/reference/graphql/2-4-6/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `eco_collection` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether the product can be returned. | | `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-6/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-6/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-6/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](/reference/graphql/2-4-6/types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-6/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](/reference/graphql/2-4-6/types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-6/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-6/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-6/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "abc123", + "activity": "xyz789", "attribute_set_id": 987, "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "xyz789", + "category_gear": "abc123", "climate": "xyz789", - "collar": "abc123", + "collar": "xyz789", "color": 123, - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, "dynamic_price": false, "dynamic_sku": false, "dynamic_weight": true, - "eco_collection": 123, - "erin_recommends": 987, - "features_bags": "xyz789", - "format": 123, - "gender": "abc123", - "gift_message_available": "abc123", - "id": 123, + "eco_collection": 987, + "erin_recommends": 123, + "features_bags": "abc123", + "format": 987, + "gender": "xyz789", + "gift_message_available": "xyz789", + "id": 987, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "items": [BundleItem], "manufacturer": 987, - "material": "abc123", + "material": "xyz789", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "abc123", "new": 123, - "new_from_date": "xyz789", + "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", "pattern": "abc123", @@ -1658,15 +1661,15 @@ Defines basic features of a bundle product and contains multiple BundleItems. "rating_summary": 123.45, "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, + "relative_url": "abc123", + "review_count": 987, "reviews": ProductReviews, - "sale": 123, + "sale": 987, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, "size": 987, "sku": "xyz789", - "sleeve": "abc123", + "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "xyz789", "special_price": 123.45, @@ -1674,15 +1677,15 @@ Defines basic features of a bundle product and contains multiple BundleItems. "staged": false, "stock_status": "IN_STOCK", "strap_bags": "xyz789", - "style_bags": "xyz789", - "style_bottom": "xyz789", + "style_bags": "abc123", + "style_bottom": "abc123", "style_general": "abc123", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": "4", "updated_at": "abc123", "upsell_products": [ProductInterface], @@ -1706,8 +1709,8 @@ Defines a single bundle product. | 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]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-6/types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-6/types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -1729,11 +1732,11 @@ Contains details about bundle products added to a requisition list. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -1742,8 +1745,8 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 } ``` @@ -1757,22 +1760,22 @@ Defines bundle product options for `ShipmentItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-6/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of shipped items. | #### Example ```json { "bundle_options": [ItemSelectedBundleOption], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_shipped": 987.65 @@ -1789,13 +1792,13 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](/reference/graphql/2-4-6/types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this wish list item. | #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md index 4d51c52ed..595dcecbf 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md @@ -8,26 +8,26 @@ Contains the contents and other details about a guest or customer cart. | Field Name | Description | |------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart contains only virtual products. | +| `applied_coupon` - [`AppliedCoupon`](/reference/graphql/2-4-6/types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](/reference/graphql/2-4-6/types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](/reference/graphql/2-4-6/types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](/reference/graphql/2-4-6/types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](/reference/graphql/2-4-6/types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/2-4-6/types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](/reference/graphql/2-4-6/types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#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!`](types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | -| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/2-4-6/types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](/reference/graphql/2-4-6/types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -49,10 +49,10 @@ Contains the contents and other details about a guest or customer cart. "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 + "total_quantity": 123.45 } ``` @@ -66,8 +66,8 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The country code. | -| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The country code. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display label for the country. | #### Example @@ -88,32 +88,32 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the customer or guest. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "abc123", - "country_code": "abc123", - "firstname": "xyz789", - "lastname": "xyz789", - "postcode": "abc123", - "region": "xyz789", - "region_id": 987, - "save_in_address_book": true, + "country_code": "xyz789", + "firstname": "abc123", + "lastname": "abc123", + "postcode": "xyz789", + "region": "abc123", + "region_id": 123, + "save_in_address_book": false, "street": ["abc123"], "telephone": "xyz789", "vat_id": "xyz789" @@ -128,39 +128,39 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company specified for the billing or shipping address. | | `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the customer or guest. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | -| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | +| [`ShippingCartAddress`](/reference/graphql/2-4-6/types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](/reference/graphql/2-4-6/types-a-b.md#billingcartaddress) | #### Example ```json { "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country": CartAddressCountry, "firstname": "abc123", "lastname": "abc123", "postcode": "xyz789", "region": CartAddressRegion, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "xyz789", - "uid": "abc123", + "uid": "xyz789", "vat_id": "xyz789" } ``` @@ -175,17 +175,17 @@ Contains details about the region in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The state or province code. | -| `label` - [`String`](types-q-s.md#string) | The display label for the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The state or province code. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "code": "xyz789", - "label": "xyz789", - "region_id": 987 + "label": "abc123", + "region_id": 123 } ``` @@ -199,8 +199,8 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the discount. | #### Example @@ -220,12 +220,12 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A localized error message | #### Example ```json -{"code": "UNDEFINED", "message": "abc123"} +{"code": "UNDEFINED", "message": "xyz789"} ``` @@ -257,10 +257,10 @@ Defines an item to be added to the cart. | Input Field | Description | |-------------|-------------| | `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | +| `parent_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-6/types-f-i.md#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!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the product. | #### Example @@ -269,8 +269,8 @@ Defines an item to be added to the cart. "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", "quantity": 987.65, - "selected_options": [4], - "sku": "xyz789" + "selected_options": ["4"], + "sku": "abc123" } ``` @@ -285,21 +285,21 @@ An interface for products in a cart. | Field Name | Description | |------------|-------------| | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](types-q-s.md#simplecartitem) | -| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | +| [`SimpleCartItem`](/reference/graphql/2-4-6/types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](/reference/graphql/2-4-6/types-t-z.md#virtualcartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](types-a-b.md#bundlecartitem) | -| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | +| [`BundleCartItem`](/reference/graphql/2-4-6/types-a-b.md#bundlecartitem) | +| [`GiftCardCartItem`](/reference/graphql/2-4-6/types-f-i.md#giftcardcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | #### Example @@ -307,11 +307,11 @@ An interface for products in a cart. ```json { "errors": [CartItemError], - "id": "xyz789", + "id": "abc123", "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -326,12 +326,12 @@ Contains details about the price of the item, including taxes and discounts. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | -| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/2-4-6/types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#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!`](/reference/graphql/2-4-6/types-k-p.md#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!`](/reference/graphql/2-4-6/types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -357,8 +357,8 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `cart_item_id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example @@ -376,9 +376,9 @@ Contains details about the price of a selected customizable value. | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](types-f-i.md#float) | A price value. | +| `type` - [`PriceTypeEnum!`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | A price value. | #### Example @@ -386,7 +386,7 @@ Contains details about the price of a selected customizable value. { "type": "FIXED", "units": "xyz789", - "value": 123.45 + "value": 987.65 } ``` @@ -400,22 +400,22 @@ A single item to be updated. | Input Field | Description | |-------------|-------------| -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | | `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/2-4-6/types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The new quantity of the item. | #### Example ```json { - "cart_item_id": 987, - "cart_item_uid": "4", + "cart_item_id": 123, + "cart_item_uid": 4, "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, - "gift_wrapping_id": 4, + "gift_wrapping_id": "4", "quantity": 123.45 } ``` @@ -433,11 +433,11 @@ Contains details about the final price of items in the cart, including discount | `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`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | -| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/2-4-6/types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `subtotal_excluding_tax` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -464,15 +464,15 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the tax. | #### Example ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -487,7 +487,7 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A localized error message. | #### Example @@ -528,13 +528,13 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -560,39 +560,39 @@ Contains the full set of attributes that can be returned in a category search. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | +| `automatic_sorting` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/2-4-6/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](/reference/graphql/2-4-6/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -605,36 +605,36 @@ Contains the full set of attributes that can be returned in a category search. ```json { "automatic_sorting": "abc123", - "available_sort_by": ["abc123"], + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "xyz789", + "canonical_url": "abc123", + "children_count": "abc123", "cms_block": CmsBlock, "created_at": "xyz789", "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", + "default_sort_by": "xyz789", "description": "xyz789", - "display_mode": "xyz789", - "filter_price_range": 987.65, - "id": 987, - "image": "abc123", - "include_in_menu": 123, + "display_mode": "abc123", + "filter_price_range": 123.45, + "id": 123, + "image": "xyz789", + "include_in_menu": 987, "is_anchor": 123, "landing_page": 987, "level": 123, - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keywords": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "xyz789", - "path": "abc123", - "path_in_store": "xyz789", - "position": 123, - "product_count": 987, + "path": "xyz789", + "path_in_store": "abc123", + "position": 987, + "product_count": 123, "products": CategoryProducts, "staged": false, "uid": 4, "updated_at": "abc123", - "url_key": "xyz789", + "url_key": "abc123", "url_path": "xyz789", "url_suffix": "abc123" } @@ -650,9 +650,9 @@ Contains details about the products assigned to a category. | Field Name | Description | |------------|-------------| -| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `items` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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 @@ -675,8 +675,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | Field Name | Description | |------------|-------------| | `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -698,82 +698,82 @@ Contains the hierarchy of categories. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled. | +| `automatic_sorting` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/2-4-6/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | | +| `children_count` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "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", + "created_at": "xyz789", "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", - "description": "abc123", + "default_sort_by": "abc123", + "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 123.45, - "id": 123, - "image": "abc123", - "include_in_menu": 123, - "is_anchor": 123, + "id": 987, + "image": "xyz789", + "include_in_menu": 987, + "is_anchor": 987, "landing_page": 987, "level": 123, "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "abc123", "path": "xyz789", "path_in_store": "xyz789", - "position": 123, - "product_count": 123, + "position": 987, + "product_count": 987, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", "staged": false, "type": "CMS_PAGE", - "uid": 4, - "updated_at": "xyz789", + "uid": "4", + "updated_at": "abc123", "url_key": "abc123", "url_path": "xyz789", "url_suffix": "abc123" @@ -790,23 +790,23 @@ Defines details about an individual checkout agreement. | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | -| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | +| `agreement_id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | | `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name given to the condition. | #### Example ```json { - "agreement_id": 123, + "agreement_id": 987, "checkbox_text": "xyz789", - "content": "xyz789", - "content_height": "xyz789", - "is_html": true, + "content": "abc123", + "content_height": "abc123", + "is_html": false, "mode": "AUTO", "name": "xyz789" } @@ -842,8 +842,8 @@ An error encountered while adding an item to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `path` - [`[String]!`](types-q-s.md#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 | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -886,7 +886,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -902,9 +902,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-6/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-6/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-6/types-f-i.md#internalerror) | #### Example @@ -923,7 +923,7 @@ Contains details about a failed close operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -942,7 +942,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/2-4-6/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -961,7 +961,7 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example @@ -979,10 +979,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `closed_quotes` - [`[NegotiableQuote]`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/2-4-6/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/2-4-6/types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1007,17 +1007,17 @@ Contains details about a specific CMS block. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | -| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | +| `content` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The title assigned to the CMS block. | #### Example ```json { "content": "xyz789", - "identifier": "abc123", - "title": "abc123" + "identifier": "xyz789", + "title": "xyz789" } ``` @@ -1049,33 +1049,33 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | +| `content` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { - "content": "abc123", + "content": "xyz789", "content_heading": "xyz789", - "identifier": "abc123", + "identifier": "xyz789", "meta_description": "xyz789", "meta_keywords": "xyz789", - "meta_title": "xyz789", - "page_layout": "abc123", + "meta_title": "abc123", + "page_layout": "xyz789", "redirect_code": 987, - "relative_url": "xyz789", - "title": "xyz789", + "relative_url": "abc123", + "title": "abc123", "type": "CMS_PAGE", "url_key": "abc123" } @@ -1089,7 +1089,7 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -1111,13 +1111,13 @@ Contains the output schema for a 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`](types-q-s.md#string) | The email address of the company contact. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | -| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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. | @@ -1125,7 +1125,7 @@ Contains the output schema for a company. | `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`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1135,10 +1135,10 @@ Contains the output schema for a company. "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "xyz789", + "email": "abc123", "id": 4, "legal_address": CompanyLegalAddress, - "legal_name": "xyz789", + "legal_name": "abc123", "name": "xyz789", "payment_methods": ["abc123"], "reseller_id": "xyz789", @@ -1164,9 +1164,9 @@ Contains details about the access control list settings of a resource. | Field Name | Description | |------------|-------------| | `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | -| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label assigned to the ACL resource. | #### Example @@ -1189,21 +1189,21 @@ Defines the input schema for creating a company administrator. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | -| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | -| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company administrator's last name. | #### Example ```json { "email": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "gender": 987, - "job_title": "xyz789", - "lastname": "abc123" + "job_title": "abc123", + "lastname": "xyz789" } ``` @@ -1218,23 +1218,23 @@ Defines the input schema for creating a new company. | Input Field | Description | |-------------|-------------| | `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String!`](types-q-s.md#string) | The name of the company to create. | +| `company_email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the company to create. | | `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { "company_admin": CompanyAdminInput, - "company_email": "abc123", - "company_name": "xyz789", + "company_email": "xyz789", + "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, "legal_name": "abc123", - "reseller_id": "abc123", + "reseller_id": "xyz789", "vat_tax_id": "abc123" } ``` @@ -1249,9 +1249,9 @@ Contains company credit balances and limits. | Field Name | Description | |------------|-------------| -| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](types-k-p.md#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. | +| `available_credit` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#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!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#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 @@ -1274,8 +1274,8 @@ Contains details about prior company credit operations. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1283,7 +1283,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1297,17 +1297,17 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The name of the person submitting the company credit operation. | +| `updated_by` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "custom_reference_number": "xyz789", + "custom_reference_number": "abc123", "operation_type": "ALLOCATION", - "updated_by": "xyz789" + "updated_by": "abc123" } ``` @@ -1321,10 +1321,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the company credit operation. | +| `amount` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of the company credit operation. | | `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](types-q-s.md#string) | The date the operation occurred. | +| `custom_reference_number` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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. | @@ -1335,7 +1335,7 @@ Contains details about a single company credit operation. "amount": Money, "balance": CompanyCredit, "custom_reference_number": "abc123", - "date": "abc123", + "date": "xyz789", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser } @@ -1372,7 +1372,7 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -1408,23 +1408,23 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The company's postal code. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company's postal code. | | `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | +| `street` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company's phone number. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "country_code": "AF", "postcode": "xyz789", "region": CustomerAddressRegion, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -1438,22 +1438,22 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "country_id": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput, - "street": ["abc123"], + "street": ["xyz789"], "telephone": "xyz789" } ``` @@ -1468,12 +1468,12 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The city where the company is registered to conduct business. | | `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -1481,7 +1481,7 @@ Defines the input schema for updating a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["xyz789"], "telephone": "abc123" @@ -1498,17 +1498,17 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the role. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name assigned to the role. | | `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | +| `users_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { "id": "4", - "name": "abc123", + "name": "xyz789", "permissions": [CompanyAclResource], "users_count": 987 } @@ -1524,14 +1524,14 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | -| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "name": "xyz789", + "name": "abc123", "permissions": ["abc123"] } ``` @@ -1546,9 +1546,9 @@ Defines the input schema for updating a company role. | Input Field | Description | |-------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | -| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | A list of resources the role can access. | #### Example @@ -1571,8 +1571,8 @@ Contains an array of roles. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -1594,17 +1594,17 @@ Contains details about a company sales representative. | Field Name | Description | |------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | -| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | -| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "xyz789", - "firstname": "xyz789", - "lastname": "xyz789" + "email": "abc123", + "firstname": "abc123", + "lastname": "abc123" } ``` @@ -1654,16 +1654,16 @@ Defines an individual node in the company structure. | Field Name | Description | |------------|-------------| | `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example ```json { "entity": CompanyTeam, - "id": "4", - "parent_id": 4 + "id": 4, + "parent_id": "4" } ``` @@ -1677,13 +1677,13 @@ Defines the input schema for updating the company structure. | Input Field | Description | |-------------|-------------| -| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | +| `parent_tree_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": "4", "tree_id": 4} +{"parent_tree_id": 4, "tree_id": 4} ``` @@ -1696,17 +1696,17 @@ Describes a company team. | Field Name | Description | |------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | -| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | ID of the company structure | #### Example ```json { "description": "xyz789", - "id": "4", + "id": 4, "name": "abc123", "structure_id": "4" } @@ -1722,9 +1722,9 @@ Defines the input schema for creating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example @@ -1746,17 +1746,17 @@ Defines the input schema for updating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the team. | #### Example ```json { - "description": "xyz789", - "id": 4, - "name": "abc123" + "description": "abc123", + "id": "4", + "name": "xyz789" } ``` @@ -1770,22 +1770,22 @@ Defines the input schema for updating a company. | Input Field | Description | |-------------|-------------| -| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String`](types-q-s.md#string) | The name of the company to update. | +| `company_email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the company to update. | | `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "company_email": "xyz789", - "company_name": "xyz789", + "company_email": "abc123", + "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "xyz789", - "reseller_id": "xyz789", + "legal_name": "abc123", + "reseller_id": "abc123", "vat_tax_id": "abc123" } ``` @@ -1800,26 +1800,26 @@ Defines the input schema for creating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The company user's email address | -| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | -| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | -| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | +| `target_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's phone number. | #### Example ```json { "email": "abc123", - "firstname": "abc123", - "job_title": "abc123", + "firstname": "xyz789", + "job_title": "xyz789", "lastname": "abc123", "role_id": "4", "status": "ACTIVE", - "target_id": "4", + "target_id": 4, "telephone": "xyz789" } ``` @@ -1853,27 +1853,27 @@ Defines the input schema for updating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The company user's email address. | -| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "abc123", "id": 4, "job_title": "xyz789", "lastname": "xyz789", - "role_id": "4", + "role_id": 4, "status": "ACTIVE", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1888,8 +1888,8 @@ Contains details about company users. | Field Name | Description | |------------|-------------| | `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of objects returned. | #### Example @@ -1929,15 +1929,15 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The label of the attribute code. | #### Example ```json { - "code": "xyz789", - "label": "xyz789" + "code": "abc123", + "label": "abc123" } ``` @@ -1951,9 +1951,9 @@ Defines an object used to iterate through items for product comparisons. | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | +| `attributes` - [`[ProductAttribute]!`](/reference/graphql/2-4-6/types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -1961,7 +1961,7 @@ Defines an object used to iterate through items for product comparisons. { "attributes": [ProductAttribute], "product": ProductInterface, - "uid": "4" + "uid": 4 } ``` @@ -1976,16 +1976,16 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| | `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](types-f-i.md#int) | The number of items in the compare list. | +| `item_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of items in the compare list. | | `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": "4" } @@ -1999,7 +1999,7 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| -| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | +| `html` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Text that can contain HTML tags. | #### Example @@ -2017,17 +2017,17 @@ Contains details about a configurable product attribute option. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | -| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | +| `code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "code": "xyz789", - "label": "xyz789", + "code": "abc123", + "label": "abc123", "uid": 4, "value_index": 123 } @@ -2043,18 +2043,18 @@ An implementation for configurable product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#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`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2067,11 +2067,11 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", + "id": "xyz789", "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -2085,15 +2085,15 @@ Describes configurable options that have been selected and can be selected as a | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { - "attribute_code": "xyz789", - "option_value_uids": [4] + "attribute_code": "abc123", + "option_value_uids": ["4"] } ``` @@ -2107,87 +2107,87 @@ Defines basic features of a configurable product and its simple product variants | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `activity` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `category_gear` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `eco_collection` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `options_container` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-6/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-6/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-6/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `size` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-6/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-6/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/2-4-6/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2195,42 +2195,42 @@ Defines basic features of a configurable product and its simple product variants { "activity": "abc123", "attribute_set_id": 987, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "xyz789", - "climate": "abc123", - "collar": "xyz789", + "category_gear": "abc123", + "climate": "xyz789", + "collar": "abc123", "color": 987, "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "abc123", - "created_at": "abc123", + "country_of_manufacture": "xyz789", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "description": ComplexTextValue, - "eco_collection": 987, - "erin_recommends": 987, - "features_bags": "abc123", + "eco_collection": 123, + "erin_recommends": 123, + "features_bags": "xyz789", "format": 987, "gender": "abc123", - "gift_message_available": "abc123", + "gift_message_available": "xyz789", "id": 123, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 123, + "manufacturer": 987, "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "xyz789", - "name": "xyz789", + "meta_title": "abc123", + "name": "abc123", "new": 123, "new_from_date": "xyz789", "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", - "pattern": "xyz789", + "pattern": "abc123", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, @@ -2243,29 +2243,29 @@ Defines basic features of a configurable product and its simple product variants "relative_url": "xyz789", "review_count": 123, "reviews": ProductReviews, - "sale": 987, + "sale": 123, "short_description": ComplexTextValue, - "size": 987, + "size": 123, "sku": "xyz789", "sleeve": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, + "special_from_date": "abc123", + "special_price": 987.65, "special_to_date": "xyz789", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", "strap_bags": "xyz789", - "style_bags": "abc123", - "style_bottom": "abc123", + "style_bags": "xyz789", + "style_bottom": "xyz789", "style_general": "abc123", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", - "uid": "4", - "updated_at": "xyz789", + "type_id": "xyz789", + "uid": 4, + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "xyz789", @@ -2287,8 +2287,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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`](types-q-s.md#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](types-q-s.md#string) | Deprecated. Use `CartItemInput.sku` instead. | +| `parent_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Deprecated. Use `CartItemInput.sku` instead. | #### Example @@ -2311,9 +2311,9 @@ Contains details about configurable product options. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the configurable option. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the configurable option. | | `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example @@ -2321,7 +2321,7 @@ Contains details about configurable product options. ```json { "attribute_code": "abc123", - "label": "xyz789", + "label": "abc123", "uid": "4", "values": [ConfigurableProductOptionValue] } @@ -2337,11 +2337,11 @@ Defines a value for a configurable product option. | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](/reference/graphql/2-4-6/types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the value. | #### Example @@ -2365,16 +2365,16 @@ Defines configurable attributes for the specified product. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is the default. | +| `attribute_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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 @@ -2382,15 +2382,15 @@ Defines configurable attributes for the specified product. ```json { "attribute_code": "abc123", - "attribute_id": "xyz789", + "attribute_id": "abc123", "attribute_id_v2": 987, - "attribute_uid": 4, + "attribute_uid": "4", "id": 123, "label": "xyz789", - "position": 987, + "position": 123, "product_id": 123, - "uid": 4, - "use_default": true, + "uid": "4", + "use_default": false, "values": [ConfigurableProductOptionsValues] } ``` @@ -2406,9 +2406,9 @@ Contains metadata corresponding to the selected configurable options. | Field Name | Description | |------------|-------------| | `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#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`](types-q-s.md#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. | +| `variant` - [`SimpleProduct`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -2433,24 +2433,24 @@ Contains the index number assigned to a configurable product option. | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | -| `label` - [`String`](types-q-s.md#string) | The label of the product. | -| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | +| `default_label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](/reference/graphql/2-4-6/types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { "default_label": "xyz789", - "label": "xyz789", + "label": "abc123", "store_label": "xyz789", "swatch_data": SwatchDataInterface, - "uid": 4, - "use_default_value": false, + "uid": "4", + "use_default_value": true, "value_index": 987 } ``` @@ -2465,11 +2465,11 @@ Contains details about configurable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](/reference/graphql/2-4-6/types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2494,7 +2494,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](/reference/graphql/2-4-6/types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -2515,15 +2515,15 @@ A configurable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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]`](/reference/graphql/2-4-6/types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -2534,8 +2534,8 @@ A configurable product wish list item. "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -2551,12 +2551,12 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -2569,7 +2569,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -2587,9 +2587,9 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -2609,23 +2609,23 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | -| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | -| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | +| `available_regions` - [`[Region]`](/reference/graphql/2-4-6/types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { "available_regions": [Region], - "full_name_english": "abc123", + "full_name_english": "xyz789", "full_name_locale": "xyz789", - "id": "abc123", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "id": "xyz789", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "abc123" } ``` @@ -2973,12 +2973,12 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example ```json -{"products": [4]} +{"products": ["4"]} ``` @@ -2991,14 +2991,14 @@ Defines a new gift registry. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | -| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-6/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](/reference/graphql/2-4-6/types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](/reference/graphql/2-4-6/types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/2-4-6/types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](/reference/graphql/2-4-6/types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3007,7 +3007,7 @@ Defines a new gift registry. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "xyz789", + "event_name": "abc123", "gift_registry_type_uid": 4, "message": "xyz789", "privacy_settings": "PRIVATE", @@ -3027,7 +3027,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3045,20 +3045,20 @@ Contains the secure information used to authorize transaction. Applies to Payflo | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | +| `response_message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { - "response_message": "xyz789", + "response_message": "abc123", "result": 123, - "result_code": 123, - "secure_token": "abc123", + "result_code": 987, + "secure_token": "xyz789", "secure_token_id": "abc123" } ``` @@ -3073,11 +3073,11 @@ Defines a new product review. | Input Field | Description | |-------------|-------------| -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `nickname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](/reference/graphql/2-4-6/types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The review text. | #### Example @@ -3101,7 +3101,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | +| `review` - [`ProductReview!`](/reference/graphql/2-4-6/types-k-p.md#productreview) | Product review details. | #### Example @@ -3120,7 +3120,7 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example @@ -3139,9 +3139,9 @@ Defines a set of conditions that apply to a rule. | 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!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -3150,7 +3150,7 @@ Defines a set of conditions that apply to a rule. "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, "attribute": "GRAND_TOTAL", "operator": "MORE_THAN", - "quantity": 987 + "quantity": 123 } ``` @@ -3164,15 +3164,15 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { "description": "xyz789", - "name": "xyz789" + "name": "abc123" } ``` @@ -3186,7 +3186,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -3204,8 +3204,8 @@ Defines the name and visibility of a new wish list. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](/reference/graphql/2-4-6/types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -3223,7 +3223,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -3241,19 +3241,19 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | Input Field | Description | |-------------|-------------| -| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | +| `cc_exp_month` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The credit card type. | #### Example ```json { - "cc_exp_month": 987, - "cc_exp_year": 987, + "cc_exp_month": 123, + "cc_exp_year": 123, "cc_last_4": 987, - "cc_type": "xyz789" + "cc_type": "abc123" } ``` @@ -3267,10 +3267,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-6/types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CreditMemo` object. | | `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | +| `number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -3278,9 +3278,9 @@ Contains credit memo details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [CreditMemoItemInterface], - "number": "abc123", + "number": "xyz789", "total": CreditMemoTotal } ``` @@ -3294,24 +3294,24 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | #### Example ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 } ``` @@ -3326,20 +3326,20 @@ Credit memo item details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | +| [`BundleCreditMemoItem`](/reference/graphql/2-4-6/types-a-b.md#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](/reference/graphql/2-4-6/types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -3349,7 +3349,7 @@ Credit memo item details. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_refunded": 987.65 @@ -3366,15 +3366,15 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `adjustment` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The final base grand total amount in the base currency. | | `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | +| `grand_total` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-6/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-6/types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -3400,13 +3400,13 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](types-q-s.md#string) | The currency symbol that is displayed by default, such as $. | +| `available_currency_codes` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -3414,10 +3414,10 @@ Contains credit memo price details. ```json { "available_currency_codes": ["abc123"], - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", - "default_display_currecy_code": "abc123", - "default_display_currecy_symbol": "xyz789", + "default_display_currecy_code": "xyz789", + "default_display_currecy_symbol": "abc123", "default_display_currency_code": "xyz789", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] @@ -3621,7 +3621,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](/reference/graphql/2-4-6/types-a-b.md#attribute) | An array of attributes. | #### Example @@ -3640,80 +3640,80 @@ Defines the customer name, addresses, and other details. | Field Name | Description | |------------|-------------| | `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `allow_remote_shopping_assistance` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#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`](types-q-s.md#string) | Timestamp indicating when the account was created. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | Details about a specific gift registry. | -| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the account was created. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | Details about a specific gift registry. | +| `group_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's middle name. | | `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](types-q-s.md#rewardpoints) | Customer reward points details. | +| `prefix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](/reference/graphql/2-4-6/types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](/reference/graphql/2-4-6/types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#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`](/reference/graphql/2-4-6/types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](/reference/graphql/2-4-6/types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](/reference/graphql/2-4-6/types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-f-i.md#id) | ID of the company structure | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `structure_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#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. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/2-4-6/types-t-z.md#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], - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "compare_list": CompareList, - "created_at": "abc123", - "date_of_birth": "xyz789", - "default_billing": "abc123", - "default_shipping": "abc123", - "dob": "xyz789", - "email": "xyz789", - "firstname": "abc123", - "gender": 123, + "created_at": "xyz789", + "date_of_birth": "abc123", + "default_billing": "xyz789", + "default_shipping": "xyz789", + "dob": "abc123", + "email": "abc123", + "firstname": "xyz789", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 123, - "id": 123, - "is_subscribed": true, - "job_title": "xyz789", + "group_id": 987, + "id": 987, + "is_subscribed": false, + "job_title": "abc123", "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, + "purchase_orders_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -3723,8 +3723,8 @@ Defines the customer name, addresses, and other details. "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "xyz789", - "taxvat": "xyz789", + "suffix": "abc123", + "taxvat": "abc123", "team": CompanyTeam, "telephone": "abc123", "wishlist": Wishlist, @@ -3743,53 +3743,53 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's company. | | `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](types-q-s.md#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `country_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the customer's default shipping address. | +| `customer_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `fax` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-f-i.md#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], - "customer_id": 123, + "customer_id": 987, "default_billing": false, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", + "fax": "xyz789", + "firstname": "xyz789", "id": 987, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, - "street": ["xyz789"], - "suffix": "xyz789", + "street": ["abc123"], + "suffix": "abc123", "telephone": "abc123", "vat_id": "xyz789" } @@ -3805,8 +3805,8 @@ Specifies the attribute code and value of a customer address attribute. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](types-q-s.md#string) | The valuue assigned to the customer address attribute. | +| `attribute_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The valuue assigned to the customer address attribute. | #### Example @@ -3827,14 +3827,14 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | -| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "abc123" } ``` @@ -3849,39 +3849,39 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `default_billing` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `street` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "AF", "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], - "default_billing": true, - "default_shipping": false, + "default_billing": false, + "default_shipping": true, "fax": "abc123", - "firstname": "xyz789", - "lastname": "abc123", + "firstname": "abc123", + "lastname": "xyz789", "middlename": "abc123", "postcode": "xyz789", "prefix": "abc123", @@ -3889,7 +3889,7 @@ Contains details about a billing or shipping address. "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -3903,9 +3903,9 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -3913,7 +3913,7 @@ Defines the customer's state or province. { "region": "xyz789", "region_code": "abc123", - "region_id": 987 + "region_id": 123 } ``` @@ -3927,9 +3927,9 @@ Defines the customer's state or province. | Input Field | Description | |-------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -3937,7 +3937,7 @@ Defines the customer's state or province. { "region": "abc123", "region_code": "abc123", - "region_id": 987 + "region_id": 123 } ``` @@ -3951,30 +3951,30 @@ An input object for creating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "date_of_birth": "xyz789", "dob": "abc123", - "email": "abc123", - "firstname": "abc123", - "gender": 987, + "email": "xyz789", + "firstname": "xyz789", + "gender": 123, "is_subscribed": false, "lastname": "xyz789", "middlename": "abc123", @@ -3995,19 +3995,19 @@ Contains details about a single downloadable product. | Field Name | Description | |------------|-------------| -| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | -| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | +| `date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "date": "xyz789", + "date": "abc123", "download_url": "xyz789", - "order_increment_id": "abc123", + "order_increment_id": "xyz789", "remaining_downloads": "abc123", "status": "xyz789" } @@ -4041,34 +4041,34 @@ An input object that assigns or updates customer attributes. | Input Field | Description | |-------------|-------------| -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `date_of_birth` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "date_of_birth": "abc123", - "dob": "xyz789", + "dob": "abc123", "email": "abc123", "firstname": "xyz789", "gender": 987, - "is_subscribed": false, + "is_subscribed": true, "lastname": "abc123", - "middlename": "xyz789", - "password": "abc123", + "middlename": "abc123", + "password": "xyz789", "prefix": "abc123", - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "abc123" } ``` @@ -4083,38 +4083,38 @@ Contains details about each of the customer's orders. | Field Name | Description | |------------|-------------| -| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `billing_address` - [`OrderAddress`](/reference/graphql/2-4-6/types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-6/types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | | `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | -| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](types-q-s.md#string) | The order number. | -| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | -| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | -| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | -| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | -| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](/reference/graphql/2-4-6/types-f-i.md#invoice) | A list of invoices for the order. | +| `items` - [`[OrderItemInterface]`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `payment_methods` - [`[OrderPaymentMethod]`](/reference/graphql/2-4-6/types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](/reference/graphql/2-4-6/types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](/reference/graphql/2-4-6/types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](/reference/graphql/2-4-6/types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The current status of the order. | +| `total` - [`OrderTotal`](/reference/graphql/2-4-6/types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example ```json { "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "created_at": "abc123", "credit_memos": [CreditMemo], @@ -4127,15 +4127,15 @@ Contains details about each of the customer's orders. "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", - "order_date": "abc123", + "number": "abc123", + "order_date": "xyz789", "order_number": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", + "shipping_method": "abc123", "status": "xyz789", "total": OrderTotal } @@ -4151,7 +4151,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -4190,8 +4190,8 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The total count of customer orders. | #### Example @@ -4213,7 +4213,7 @@ Identifies the filter to use for filtering orders. | Input Field | Description | |-------------|-------------| -| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `number` - [`FilterStringTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterstringtypeinput) | Filters by order number. | #### Example @@ -4249,7 +4249,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](/reference/graphql/2-4-6/types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -4268,8 +4268,8 @@ Contains store credit information with balance and history. | 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`](types-k-p.md#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | +| `current_balance` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -4277,7 +4277,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": false + "enabled": true } ``` @@ -4292,8 +4292,8 @@ Lists changes to the amount of store credit available to the customer. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of items returned. | #### Example @@ -4315,16 +4315,16 @@ Contains store credit history information. | Field Name | Description | |------------|-------------| -| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | +| `action` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time when the store credit change was made. | #### Example ```json { - "action": "xyz789", + "action": "abc123", "actual_balance": Money, "balance_change": Money, "date_time_changed": "xyz789" @@ -4341,12 +4341,12 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | +| `token` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer authorization token. | #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -4359,33 +4359,33 @@ An input object for updating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "date_of_birth": "xyz789", "dob": "abc123", - "firstname": "abc123", - "gender": 987, + "firstname": "xyz789", + "gender": 123, "is_subscribed": true, "lastname": "xyz789", - "middlename": "xyz789", - "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "abc123" + "middlename": "abc123", + "prefix": "xyz789", + "suffix": "abc123", + "taxvat": "xyz789" } ``` @@ -4399,22 +4399,22 @@ Contains information about a text area that is defined as part of a customizable | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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": "abc123", + "option_id": 123, + "product_sku": "xyz789", "required": false, - "sort_order": 123, + "sort_order": 987, "title": "abc123", "uid": 4, "value": CustomizableAreaValue @@ -4431,21 +4431,21 @@ Defines the price and sku of a product whose page contains a customized text are | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | +| `max_characters` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "max_characters": 123, + "max_characters": 987, "price": 987.65, "price_type": "FIXED", "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -4459,21 +4459,21 @@ Contains information about a set of checkbox values that are defined as part of | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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, + "option_id": 123, "required": false, - "sort_order": 987, - "title": "abc123", + "sort_order": 123, + "title": "xyz789", "uid": 4, "value": [CustomizableCheckboxValue] } @@ -4489,23 +4489,23 @@ Defines the price and sku of a product whose page contains a customized set of c | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 123.45, "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, + "sku": "xyz789", + "sort_order": 123, "title": "abc123", "uid": "4" } @@ -4521,24 +4521,24 @@ Contains information about a date picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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, + "option_id": 123, "product_sku": "abc123", "required": true, - "sort_order": 123, + "sort_order": 987, "title": "abc123", - "uid": "4", + "uid": 4, "value": CustomizableDateValue } ``` @@ -4573,21 +4573,21 @@ Defines the price and sku of a product whose page contains a customized date pic | Field Name | Description | |------------|-------------| -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | | `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "type": "DATE", - "uid": 4 + "uid": "4" } ``` @@ -4601,20 +4601,20 @@ Contains information about a drop down menu that is defined as part of a customi | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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, + "option_id": 987, "required": false, - "sort_order": 123, + "sort_order": 987, "title": "xyz789", "uid": "4", "value": [CustomizableDropDownValue] @@ -4631,25 +4631,25 @@ Defines the price and sku of a product whose page contains a customized drop dow | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "option_type_id": 987, - "price": 987.65, + "option_type_id": 123, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", - "sort_order": 123, + "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -4663,12 +4663,12 @@ Contains information about a text field that is defined as part of a customizabl | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example @@ -4676,10 +4676,10 @@ Contains information about a text field that is defined as part of a customizabl ```json { "option_id": 987, - "product_sku": "abc123", + "product_sku": "xyz789", "required": false, "sort_order": 987, - "title": "abc123", + "title": "xyz789", "uid": "4", "value": CustomizableFieldValue } @@ -4695,20 +4695,20 @@ Defines the price and sku of a product whose page contains a customized text fie | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | +| `max_characters` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { - "max_characters": 987, + "max_characters": 123, "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "uid": 4 } ``` @@ -4723,12 +4723,12 @@ Contains information about a file picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -4736,10 +4736,10 @@ Contains information about a file picker that is defined as part of a customizab ```json { "option_id": 987, - "product_sku": "xyz789", - "required": false, + "product_sku": "abc123", + "required": true, "sort_order": 987, - "title": "xyz789", + "title": "abc123", "uid": "4", "value": CustomizableFileValue } @@ -4755,24 +4755,24 @@ Defines the price and sku of a product whose page contains a customized file pic | Field Name | Description | |------------|-------------| -| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | -| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | +| `file_extension` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "file_extension": "abc123", - "image_size_x": 123, - "image_size_y": 123, - "price": 987.65, + "file_extension": "xyz789", + "image_size_x": 987, + "image_size_y": 987, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "uid": "4" } ``` @@ -4787,19 +4787,19 @@ Contains information about a multiselect that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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, + "option_id": 123, + "required": true, "sort_order": 987, "title": "xyz789", "uid": "4", @@ -4817,13 +4817,13 @@ Defines the price and sku of a product whose page contains a customized multisel | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example @@ -4832,9 +4832,9 @@ Defines the price and sku of a product whose page contains a customized multisel "option_type_id": 123, "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 123, - "title": "abc123", + "title": "xyz789", "uid": 4 } ``` @@ -4849,13 +4849,13 @@ Defines a customizable option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | -| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The customizable option ID of the product. | +| `value_string` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The string value of the option. | #### Example ```json -{"id": 123, "value_string": "abc123"} +{"id": 987, "value_string": "xyz789"} ``` @@ -4868,11 +4868,11 @@ Contains basic information about a customizable option. It can be implemented by | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -4893,7 +4893,7 @@ Contains basic information about a customizable option. It can be implemented by { "option_id": 123, "required": true, - "sort_order": 987, + "sort_order": 123, "title": "xyz789", "uid": 4 } @@ -4915,11 +4915,11 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`VirtualProduct`](/reference/graphql/2-4-6/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-6/types-q-s.md#simpleproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`BundleProduct`](/reference/graphql/2-4-6/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-6/types-f-i.md#giftcardproduct) | | [`ConfigurableProduct`](#configurableproduct) | #### Example @@ -4938,11 +4938,11 @@ Contains information about a set of radio buttons that are defined as part of a | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example @@ -4950,9 +4950,9 @@ Contains information about a set of radio buttons that are defined as part of a ```json { "option_id": 123, - "required": false, + "required": true, "sort_order": 123, - "title": "abc123", + "title": "xyz789", "uid": 4, "value": [CustomizableRadioValue] } @@ -4968,25 +4968,25 @@ Defines the price and sku of a product whose page contains a customized set of r | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-6/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "option_type_id": 123, - "price": 123.45, + "option_type_id": 987, + "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, + "sku": "abc123", + "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5000,7 +5000,7 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example @@ -5018,12 +5018,12 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -5036,7 +5036,7 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example @@ -5054,7 +5054,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -5070,9 +5070,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-6/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-6/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-6/types-f-i.md#internalerror) | #### Example @@ -5091,14 +5091,14 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -5110,7 +5110,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/2-4-6/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -5127,12 +5127,12 @@ NegotiableQuoteUidOperationSuccess | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example ```json -{"quote_uids": [4]} +{"quote_uids": ["4"]} ``` @@ -5145,9 +5145,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/2-4-6/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/2-4-6/types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -5172,14 +5172,14 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example ```json { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } ``` @@ -5193,7 +5193,7 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The text of the error message. | +| `message` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example @@ -5229,7 +5229,7 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example @@ -5265,7 +5265,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -5283,13 +5283,13 @@ Indicates whether the request to delete the requisition list was successful. | Field Name | Description | |------------|-------------| -| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | +| `requisition_lists` - [`RequisitionLists`](/reference/graphql/2-4-6/types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example ```json -{"requisition_lists": RequisitionLists, "status": false} +{"requisition_lists": RequisitionLists, "status": true} ``` @@ -5302,8 +5302,8 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example @@ -5321,15 +5321,15 @@ Defines an individual discount. A discount can be applied to the cart as a whole | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | -| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of the discount. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A description of the discount. | #### Example ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -5343,15 +5343,15 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -5365,7 +5365,7 @@ An implementation for downloadable product cart items. "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": "4" + "uid": 4 } ``` @@ -5381,12 +5381,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | #### Example @@ -5396,10 +5396,10 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -5432,12 +5432,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -5445,12 +5445,12 @@ Defines downloadable product options for `InvoiceItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -5464,16 +5464,16 @@ Defines characteristics of the links for downloadable product. | Field Name | Description | |------------|-------------| -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json { "sort_order": 987, - "title": "abc123", + "title": "xyz789", "uid": 4 } ``` @@ -5490,24 +5490,24 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-6/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-6/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The status of the order item. | #### Example @@ -5515,24 +5515,24 @@ Defines downloadable product options for `OrderItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 987.65, + "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_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -5546,87 +5546,87 @@ Defines a product that the shopper downloads. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `activity` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | +| `category_gear` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `eco_collection` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `options_container` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-6/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-6/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-6/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `size` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-6/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-6/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-6/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | #### Example @@ -5634,13 +5634,13 @@ Defines a product that the shopper downloads. { "activity": "abc123", "attribute_set_id": 987, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "xyz789", + "category_gear": "abc123", "climate": "abc123", "collar": "abc123", "color": 123, - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, @@ -5651,23 +5651,23 @@ Defines a product that the shopper downloads. DownloadableProductSamples ], "eco_collection": 987, - "erin_recommends": 987, - "features_bags": "abc123", + "erin_recommends": 123, + "features_bags": "xyz789", "format": 987, "gender": "abc123", "gift_message_available": "xyz789", - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "xyz789", - "links_purchased_separately": 987, - "links_title": "xyz789", - "manufacturer": 987, - "material": "abc123", + "links_purchased_separately": 123, + "links_title": "abc123", + "manufacturer": 123, + "material": "xyz789", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "xyz789", "new": 987, "new_from_date": "xyz789", @@ -5676,7 +5676,7 @@ Defines a product that the shopper downloads. "options": [CustomizableOptionInterface], "options_container": "xyz789", "pattern": "abc123", - "performance_fabric": 123, + "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -5685,10 +5685,10 @@ Defines a product that the shopper downloads. "rating_summary": 987.65, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, + "relative_url": "xyz789", + "review_count": 987, "reviews": ProductReviews, - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, "size": 123, "sku": "xyz789", @@ -5697,25 +5697,25 @@ Defines a product that the shopper downloads. "special_from_date": "abc123", "special_price": 123.45, "special_to_date": "abc123", - "staged": false, + "staged": true, "stock_status": "IN_STOCK", "strap_bags": "xyz789", - "style_bags": "xyz789", + "style_bags": "abc123", "style_bottom": "xyz789", "style_general": "abc123", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -5756,17 +5756,17 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](types-a-b.md#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | +| `sample_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example @@ -5779,10 +5779,10 @@ Defines characteristics of a downloadable product. "price": 123.45, "sample_file": "xyz789", "sample_type": "FILE", - "sample_url": "abc123", + "sample_url": "xyz789", "sort_order": 123, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5796,7 +5796,7 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example @@ -5814,12 +5814,12 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | +| `sample_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the sample. | #### Example @@ -5829,7 +5829,7 @@ Defines characteristics of a downloadable product. "sample_file": "abc123", "sample_type": "FILE", "sample_url": "abc123", - "sort_order": 987, + "sort_order": 123, "title": "abc123" } ``` @@ -5844,12 +5844,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of the product added to the requisition list. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -5860,7 +5860,7 @@ Contains details about downloadable products added to a requisition list. "product": ProductInterface, "quantity": 123.45, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -5874,23 +5874,23 @@ A downloadable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `added_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | | `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, + "description": "xyz789", + "id": "4", "links_v2": [DownloadableProductLinks], "product": ProductInterface, "quantity": 123.45, @@ -5909,15 +5909,12 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json -{ - "content": ComplexTextValue, - "uid": "4" -} +{"content": ComplexTextValue, "uid": 4} ``` @@ -5973,8 +5970,8 @@ Contains an array of dynamic blocks. | Field Name | Description | |------------|-------------| | `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -5982,7 +5979,7 @@ Contains an array of dynamic blocks. { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5996,14 +5993,18 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](types-f-i.md#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](/reference/graphql/2-4-6/types-f-i.md#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"} +{ + "dynamic_block_uids": ["4"], + "locations": ["CONTENT"], + "type": "SPECIFIED" +} ``` @@ -6016,15 +6017,15 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The text or other entered value. | #### Example ```json { - "attribute_code": "xyz789", - "value": "abc123" + "attribute_code": "abc123", + "value": "xyz789" } ``` @@ -6038,16 +6039,13 @@ Defines a customer-entered option. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Text the customer entered. | #### Example ```json -{ - "uid": "4", - "value": "xyz789" -} +{"uid": 4, "value": "abc123"} ``` @@ -6060,18 +6058,18 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "entity_uid": 4, "id": 987, "redirectCode": 987, @@ -6088,20 +6086,20 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-6/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-6/types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-6/types-k-p.md#negotiablequoteinvalidstateerror) | #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -6114,13 +6112,13 @@ Lists the exchange rate. | Field Name | Description | |------------|-------------| -| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | +| `currency_to` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "xyz789", "rate": 987.65} +{"currency_to": "abc123", "rate": 123.45} ``` @@ -6133,10 +6131,10 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID to assign to the cart. | #### Example ```json -{"cart_id": "xyz789"} +{"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 index 0aa1d13fb..917762497 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 @@ -8,15 +8,15 @@ Defines a filter that matches the input exactly. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"]`. | +| `eq` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](/reference/graphql/2-4-6/types-q-s.md#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"] + "eq": "xyz789", + "in": ["abc123"] } ``` @@ -30,7 +30,7 @@ Defines a filter that performs a fuzzy search. | Input Field | Description | |-------------|-------------| -| `match` - [`String`](types-q-s.md#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`. | +| `match` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -48,14 +48,14 @@ Defines a filter that matches a range of values, such as prices or dates. | Input Field | Description | |-------------|-------------| -| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | +| `from` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example ```json { - "from": "xyz789", + "from": "abc123", "to": "abc123" } ``` @@ -70,17 +70,17 @@ Defines a filter for an input string. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | +| `eq` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example ```json { "eq": "abc123", - "in": ["abc123"], - "match": "abc123" + "in": ["xyz789"], + "match": "xyz789" } ``` @@ -94,41 +94,41 @@ Defines the comparison operators that can be used in a filter. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Equals. | -| `finset` - [`[String]`](types-q-s.md#string) | | -| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](types-q-s.md#string) | Greater than. | -| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | -| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](types-q-s.md#string) | Less than. | -| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | -| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | -| `neq` - [`String`](types-q-s.md#string) | Not equal to. | -| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](types-q-s.md#string) | Not null. | -| `null` - [`String`](types-q-s.md#string) | Is null. | -| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | +| `eq` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `from` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Less than. | +| `lteq` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Not null. | +| `null` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Is null. | +| `to` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { - "eq": "abc123", - "finset": ["xyz789"], - "from": "xyz789", - "gt": "xyz789", - "gteq": "abc123", - "in": ["xyz789"], - "like": "xyz789", - "lt": "xyz789", + "eq": "xyz789", + "finset": ["abc123"], + "from": "abc123", + "gt": "abc123", + "gteq": "xyz789", + "in": ["abc123"], + "like": "abc123", + "lt": "abc123", "lteq": "abc123", "moreq": "abc123", "neq": "abc123", "nin": ["abc123"], - "notnull": "xyz789", + "notnull": "abc123", "null": "xyz789", - "to": "abc123" + "to": "xyz789" } ``` @@ -142,8 +142,8 @@ A single FPT that can be applied to a product price. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | +| `amount` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example @@ -187,7 +187,7 @@ values as specified by #### Example ```json -987.65 +123.45 ``` @@ -200,7 +200,7 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example @@ -218,12 +218,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | +| `customer_token` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "xyz789"} +{"customer_token": "abc123"} ``` @@ -236,9 +236,9 @@ Contains details about the gift card account. | Field Name | Description | |------------|-------------| -| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `balance` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -246,7 +246,7 @@ Contains details about the gift card account. { "balance": Money, "code": "xyz789", - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -260,7 +260,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The applied gift card code. | #### Example @@ -289,11 +289,11 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { - "attribute_id": 987, - "uid": 4, + "attribute_id": 123, + "uid": "4", "value": 123.45, - "value_id": 123, - "website_id": 123, + "value_id": 987, + "website_id": 987, "website_value": 123.45 } ``` @@ -308,18 +308,18 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount and currency of the gift card. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount and currency of the gift card. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-6/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `message` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The message from the sender to the recipient. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-6/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about an item in the cart. | | `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | -| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `recipient_email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -330,15 +330,15 @@ Contains details about a gift card that has been added to a cart. "customizable_options": [SelectedCustomizableOption], "errors": [CartItemError], "id": "abc123", - "message": "xyz789", + "message": "abc123", "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "recipient_email": "xyz789", + "recipient_email": "abc123", "recipient_name": "abc123", - "sender_email": "xyz789", + "sender_email": "abc123", "sender_name": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -350,13 +350,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#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`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -367,9 +367,9 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 987.65 } ``` @@ -382,13 +382,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -397,11 +397,11 @@ Contains details about a gift card that has been added to a cart. { "discounts": [Discount], "gift_card": GiftCardItem, - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 123.45 } ``` @@ -416,21 +416,21 @@ Contains details about a gift card. | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | +| `message` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example ```json { - "message": "abc123", - "recipient_email": "abc123", + "message": "xyz789", + "recipient_email": "xyz789", "recipient_name": "xyz789", - "sender_email": "xyz789", - "sender_name": "abc123" + "sender_email": "abc123", + "sender_name": "xyz789" } ``` @@ -444,13 +444,13 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | +| `amount` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -458,10 +458,10 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "abc123", - "recipient_email": "abc123", + "message": "xyz789", + "recipient_email": "xyz789", "recipient_name": "xyz789", - "sender_email": "abc123", + "sender_email": "xyz789", "sender_name": "abc123" } ``` @@ -474,49 +474,49 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-6/types-k-p.md#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`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-6/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The status of the order item. | #### Example ```json { "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "xyz789", + "product_type": "abc123", "product_url_key": "abc123", "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, + "quantity_invoiced": 987.65, "quantity_ordered": 987.65, "quantity_refunded": 123.45, "quantity_returned": 123.45, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -532,110 +532,110 @@ Defines properties of a gift card. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](types-a-b.md#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `activity` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `allow_message` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](/reference/graphql/2-4-6/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `gender` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](/reference/graphql/2-4-6/types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `material` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-6/types-k-p.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `new_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-6/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-6/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-6/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-6/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | The list of products reviews. | | `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#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`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-6/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/2-4-6/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-6/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-6/types-t-z.md#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", + "activity": "abc123", "allow_message": true, "allow_open_amount": false, "attribute_set_id": 123, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "abc123", + "category_gear": "xyz789", + "climate": "xyz789", "collar": "xyz789", - "color": 987, - "country_of_manufacture": "abc123", + "color": 123, + "country_of_manufacture": "xyz789", "created_at": "xyz789", "crosssell_products": [ProductInterface], "description": ComplexTextValue, @@ -643,76 +643,76 @@ Defines properties of a gift card. "erin_recommends": 987, "features_bags": "xyz789", "format": 123, - "gender": "xyz789", + "gender": "abc123", "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": "xyz789", + "gift_message_available": "abc123", "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", - "id": 123, + "id": 987, "image": ProductImage, - "is_redeemable": true, + "is_redeemable": false, "is_returnable": "abc123", "lifetime": 123, "manufacturer": 123, - "material": "abc123", + "material": "xyz789", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 123, + "message_max_length": 987, "meta_description": "xyz789", "meta_keyword": "xyz789", - "meta_title": "xyz789", - "name": "abc123", - "new": 123, - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "meta_title": "abc123", + "name": "xyz789", + "new": 987, + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "open_amount_max": 123.45, - "open_amount_min": 123.45, + "open_amount_min": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", "pattern": "abc123", - "performance_fabric": 987, + "performance_fabric": 123, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 987, "rating_summary": 123.45, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, + "relative_url": "abc123", + "review_count": 987, "reviews": ProductReviews, - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, "size": 987, "sku": "xyz789", - "sleeve": "abc123", + "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "xyz789", "special_price": 987.65, - "special_to_date": "abc123", + "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "abc123", + "strap_bags": "xyz789", "style_bags": "abc123", - "style_bottom": "abc123", - "style_general": "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", + "type_id": "abc123", "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "xyz789", + "url_key": "abc123", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -726,9 +726,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -739,7 +739,7 @@ Contains details about gift cards added to a requisition list. "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -754,10 +754,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -765,12 +765,12 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -804,12 +804,12 @@ A single gift card added to a wish list. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -820,9 +820,9 @@ A single gift card added to a wish list. "customizable_options": [SelectedCustomizableOption], "description": "abc123", "gift_card_options": GiftCardOptions, - "id": 4, + "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -836,16 +836,16 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | Sender name | -| `message` - [`String!`](types-q-s.md#string) | Gift message text | -| `to` - [`String!`](types-q-s.md#string) | Recipient name | +| `from` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Sender name | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Gift message text | +| `to` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "xyz789", - "message": "xyz789", + "from": "abc123", + "message": "abc123", "to": "abc123" } ``` @@ -860,17 +860,17 @@ Defines a gift message. | Input Field | Description | |-------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | -| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | -| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | +| `from` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the recepient. | #### Example ```json { "from": "xyz789", - "message": "abc123", - "to": "abc123" + "message": "xyz789", + "to": "xyz789" } ``` @@ -884,9 +884,9 @@ Contains prices for gift wrapping options. | Field Name | Description | |------------|-------------| -| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | -| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | +| `gift_wrapping_for_items` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_order` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `printed_card` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | Price for the printed card. | #### Example @@ -908,15 +908,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-q-s.md#string) | The name of the event. | +| `event_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the event. | | `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](types-q-s.md#string) | The customer who created the gift registry. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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`](types-c-e.md#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `shipping_address` - [`CustomerAddress`](/reference/graphql/2-4-6/types-c-e.md#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. | @@ -925,18 +925,18 @@ Contains details about a gift registry. ```json { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [GiftRegistryDynamicAttribute], "event_name": "abc123", "items": [GiftRegistryItemInterface], "message": "xyz789", - "owner_name": "abc123", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } ``` @@ -950,14 +950,14 @@ Contains details about a gift registry. |------------|-------------| | `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!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": "4", + "code": 4, "group": "EVENT_INFORMATION", "label": "xyz789", "value": "abc123" @@ -998,14 +998,14 @@ Defines a dynamic attribute. | Input Field | Description | |-------------|-------------| | `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example ```json { "code": "4", - "value": "abc123" + "value": "xyz789" } ``` @@ -1018,8 +1018,8 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1032,9 +1032,9 @@ Defines a dynamic attribute. ```json { - "code": "4", - "label": "xyz789", - "value": "abc123" + "code": 4, + "label": "abc123", + "value": "xyz789" } ``` @@ -1046,22 +1046,22 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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, + "attribute_group": "abc123", + "code": "4", "input_type": "xyz789", "is_required": false, - "label": "abc123", + "label": "xyz789", "sort_order": 123 } ``` @@ -1074,11 +1074,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1092,11 +1092,11 @@ Defines a dynamic attribute. ```json { "attribute_group": "abc123", - "code": 4, + "code": "4", "input_type": "abc123", "is_required": true, "label": "abc123", - "sort_order": 987 + "sort_order": 123 } ``` @@ -1108,9 +1108,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#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. | @@ -1119,12 +1119,12 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", + "created_at": "xyz789", "note": "xyz789", "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "quantity_fulfilled": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -1136,9 +1136,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#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. | @@ -1156,9 +1156,9 @@ Defines a dynamic attribute. "created_at": "xyz789", "note": "abc123", "product": ProductInterface, - "quantity": 987.65, - "quantity_fulfilled": 123.45, - "uid": 4 + "quantity": 123.45, + "quantity_fulfilled": 987.65, + "uid": "4" } ``` @@ -1172,14 +1172,14 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#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`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-6/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1203,7 +1203,7 @@ Contains details about an error that occurred when processing a gift registry it | `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!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1212,8 +1212,8 @@ Contains details about an error that occurred when processing a gift registry it { "code": "OUT_OF_STOCK", "gift_registry_item_uid": 4, - "gift_registry_uid": 4, - "message": "abc123", + "gift_registry_uid": "4", + "message": "xyz789", "product_uid": "4" } ``` @@ -1254,7 +1254,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-6/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1292,9 +1292,9 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `email` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1304,9 +1304,9 @@ Contains details about a registrant. "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", + "email": "abc123", + "firstname": "abc123", + "lastname": "xyz789", "uid": 4 } ``` @@ -1320,14 +1320,14 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": "4", + "code": 4, "label": "abc123", "value": "xyz789" } @@ -1343,12 +1343,12 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | -| `event_title` - [`String!`](types-q-s.md#string) | The title given to the event. | +| `event_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The title given to the event. | | `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](types-q-s.md#string) | The location of the event. | -| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | -| `type` - [`String`](types-q-s.md#string) | The type of event being held. | +| `location` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of event being held. | #### Example @@ -1358,8 +1358,8 @@ Contains the results of a gift registry search. "event_title": "xyz789", "gift_registry_uid": "4", "location": "abc123", - "name": "xyz789", - "type": "xyz789" + "name": "abc123", + "type": "abc123" } ``` @@ -1373,13 +1373,16 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](/reference/graphql/2-4-6/types-c-e.md#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} +{ + "address_data": CustomerAddressInput, + "address_id": "4" +} ``` @@ -1412,7 +1415,7 @@ Contains details about a gift registry type. | 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!`](types-q-s.md#string) | The label assigned to the gift registry type on the Admin. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -1423,7 +1426,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1437,17 +1440,17 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](types-q-s.md#string) | The name of the gift wrapping design. | +| `design` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-k-p.md#money) | The gift wrapping price. | +| `price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example ```json { - "design": "xyz789", + "design": "abc123", "id": "4", "image": GiftWrappingImage, "price": Money, @@ -1465,15 +1468,15 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | -| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The gift wrapping preview image URL. | #### Example ```json { - "label": "xyz789", - "url": "xyz789" + "label": "abc123", + "url": "abc123" } ``` @@ -1487,167 +1490,167 @@ Defines a grouped product, which consists of simple standalone products that are | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `activity` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](/reference/graphql/2-4-6/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `gender` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `material` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `new_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for new product listings. | | `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `options_container` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-6/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-6/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-6/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | The list of products reviews. | | `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#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`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-6/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/2-4-6/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-6/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-6/types-t-z.md#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, + "activity": "abc123", + "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "abc123", "climate": "xyz789", - "collar": "abc123", + "collar": "xyz789", "color": 123, "country_of_manufacture": "xyz789", "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, "eco_collection": 987, - "erin_recommends": 987, + "erin_recommends": 123, "features_bags": "abc123", "format": 987, - "gender": "abc123", - "gift_message_available": "abc123", + "gender": "xyz789", + "gift_message_available": "xyz789", "id": 123, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "items": [GroupedProductItem], "manufacturer": 987, - "material": "xyz789", + "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "name": "abc123", "new": 987, "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options_container": "xyz789", - "pattern": "abc123", + "pattern": "xyz789", "performance_fabric": 123, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 123, - "rating_summary": 987.65, + "rating_summary": 123.45, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, + "relative_url": "abc123", + "review_count": 987, "reviews": ProductReviews, - "sale": 987, + "sale": 123, "short_description": ComplexTextValue, "size": 123, "sku": "abc123", - "sleeve": "xyz789", + "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 123.45, - "special_to_date": "abc123", + "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", - "style_bags": "xyz789", - "style_bottom": "abc123", + "strap_bags": "abc123", + "style_bags": "abc123", + "style_bottom": "xyz789", "style_general": "abc123", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": "4", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "xyz789", + "url_key": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -1662,7 +1665,7 @@ Contains information about an individual grouped product item. | Field Name | Description | |------------|-------------| | `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example @@ -1685,23 +1688,23 @@ A grouped product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the item. | | `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1715,15 +1718,15 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](/reference/graphql/2-4-6/types-q-s.md#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": "abc123", - "return_url": "xyz789" + "cancel_url": "xyz789", + "return_url": "abc123" } ``` @@ -1737,7 +1740,7 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The secure URL generated by PayPal. | #### Example @@ -1755,7 +1758,7 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example @@ -1773,15 +1776,15 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | A parameter name. | -| `value` - [`String`](types-q-s.md#string) | A parameter value. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A parameter name. | +| `value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A parameter value. | #### Example ```json { - "name": "abc123", - "value": "abc123" + "name": "xyz789", + "value": "xyz789" } ``` @@ -1809,15 +1812,15 @@ When expected as an input type, any string (such as `"4"`) or integer | Field Name | Description | |------------|-------------| -| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `thumbnail` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json { - "thumbnail": "abc123", - "value": "abc123" + "thumbnail": "xyz789", + "value": "xyz789" } ``` @@ -1831,7 +1834,7 @@ values. Int can represent values between -(2^31) and 2^31 - 1. #### Example ```json -123 +987 ``` @@ -1844,12 +1847,12 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -1862,10 +1865,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-6/types-q-s.md#salescommentitem) | Comments on the invoice. | | `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | | `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | +| `number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -1875,7 +1878,7 @@ Contains invoice details. "comments": [SalesCommentItem], "id": "4", "items": [InvoiceItemInterface], - "number": "abc123", + "number": "xyz789", "total": InvoiceTotal } ``` @@ -1888,12 +1891,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -1903,7 +1906,7 @@ Contains invoice details. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "quantity_invoiced": 987.65 @@ -1920,20 +1923,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](/reference/graphql/2-4-6/types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](/reference/graphql/2-4-6/types-a-b.md#bundleinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -1944,10 +1947,10 @@ Contains detailes about invoiced items. "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -1961,14 +1964,14 @@ Contains price details from an invoice. | Field Name | Description | |------------|-------------| -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | +| `base_grand_total` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-6/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-6/types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -1995,7 +1998,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2013,7 +2016,7 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example @@ -2031,12 +2034,12 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example ```json -{"is_role_name_available": true} +{"is_role_name_available": false} ``` @@ -2049,7 +2052,7 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example @@ -2067,12 +2070,12 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2086,7 +2089,7 @@ A list of options of the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](types-q-s.md#string) | The label of the option. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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. | @@ -2095,8 +2098,8 @@ A list of options of the selected bundle product. ```json { "id": 4, - "label": "abc123", - "uid": "4", + "label": "xyz789", + "uid": 4, "values": [ItemSelectedBundleOptionValue] } ``` @@ -2112,9 +2115,9 @@ A list of values for the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | -| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the child bundle product. | +| `price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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. | @@ -2122,12 +2125,12 @@ A list of values for the selected bundle product. ```json { - "id": 4, + "id": "4", "price": Money, - "product_name": "abc123", + "product_name": "xyz789", "product_sku": "abc123", "quantity": 123.45, - "uid": "4" + "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 index 13e7307b2..4f8052841 100644 --- 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 @@ -8,8 +8,8 @@ Contains a key-value pair. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | -| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value part of the key/value pair. | #### Example @@ -31,9 +31,9 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| | `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | +| `filter_items_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | #### Example @@ -42,7 +42,7 @@ Contains information for rendering layered navigation. "filter_items": [LayerFilterItemInterface], "filter_items_count": 123, "name": "abc123", - "request_var": "xyz789" + "request_var": "abc123" } ``` @@ -54,9 +54,9 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example @@ -64,7 +64,7 @@ Contains information for rendering layered navigation. { "items_count": 987, "label": "xyz789", - "value_string": "abc123" + "value_string": "xyz789" } ``` @@ -76,22 +76,22 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#swatchlayerfilteritem) | +| [`SwatchLayerFilterItem`](/reference/graphql/2-4-6/types-q-s.md#swatchlayerfilteritem) | #### Example ```json { - "items_count": 123, + "items_count": 987, "label": "abc123", "value_string": "abc123" } @@ -108,14 +108,14 @@ Defines characteristics about images and videos associated with a specific produ | Field Name | Description | |------------|-------------| | `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | -| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -123,12 +123,12 @@ Defines characteristics about images and videos associated with a specific produ ```json { "content": ProductMediaGalleryEntriesContent, - "disabled": true, + "disabled": false, "file": "abc123", "id": 123, "label": "xyz789", - "media_type": "abc123", - "position": 987, + "media_type": "xyz789", + "position": 123, "types": ["abc123"], "uid": "4", "video_content": ProductMediaGalleryEntriesVideoContent @@ -145,10 +145,10 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -161,7 +161,7 @@ Contains basic information about a product image or video. ```json { - "disabled": true, + "disabled": false, "label": "abc123", "position": 987, "url": "xyz789" @@ -178,8 +178,8 @@ Defines a monetary value, including a numeric value and a currency code. | Field Name | Description | |------------|-------------| -| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | +| `currency` - [`CurrencyEnum`](/reference/graphql/2-4-6/types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | A number expressing a monetary value. | #### Example @@ -197,9 +197,9 @@ Contains the customer's gift registry and any errors encountered. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](/reference/graphql/2-4-6/types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -221,7 +221,7 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example @@ -239,8 +239,8 @@ Output of the request to move items to another requisition list. | Field Name | Description | |------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | +| `destination_requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -261,9 +261,9 @@ Contains the source and target wish lists after moving products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -285,23 +285,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/2-4-6/types-a-b.md#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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](types-q-s.md#string) | The email address of the company user. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/2-4-6/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](/reference/graphql/2-4-6/types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-f-i.md#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -312,9 +312,9 @@ Contains details about a negotiable quote. "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "email": "xyz789", + "email": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "abc123", "prices": CartPrices, @@ -322,7 +322,7 @@ Contains details about a negotiable quote. "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", "total_quantity": 123.45, - "uid": 4, + "uid": "4", "updated_at": "abc123" } ``` @@ -337,14 +337,14 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The address country code. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The address country code. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the region. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "label": "xyz789" } ``` @@ -359,32 +359,32 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company name. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country_code": "abc123", - "firstname": "abc123", - "lastname": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", "postcode": "xyz789", - "region": "xyz789", + "region": "abc123", "region_id": 123, - "save_in_address_book": false, - "street": ["abc123"], + "save_in_address_book": true, + "street": ["xyz789"], "telephone": "abc123" } ``` @@ -397,15 +397,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -418,15 +418,15 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "abc123" + "street": ["abc123"], + "telephone": "xyz789" } ``` @@ -440,16 +440,16 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The address region code. | -| `label` - [`String`](types-q-s.md#string) | The display name of the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The address region code. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "code": "abc123", - "label": "abc123", + "label": "xyz789", "region_id": 987 } ``` @@ -462,29 +462,29 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's telephone number. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "xyz789", + "firstname": "abc123", + "lastname": "abc123", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["xyz789"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -499,16 +499,16 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", + "customer_address_uid": 4, "same_as_shipping": true, "use_for_shipping": true } @@ -525,10 +525,10 @@ Contains a single plain text comment from either the buyer or seller. | Field Name | Description | |------------|-------------| | `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the comment was created. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the comment was created. | | `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | +| `text` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example @@ -569,12 +569,12 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | +| `comment` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The comment provided by the buyer. | #### Example ```json -{"comment": "xyz789"} +{"comment": "abc123"} ``` @@ -587,17 +587,17 @@ Contains custom log entries added by third-party extensions. | Field Name | Description | |------------|-------------| -| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | -| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | -| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | +| `new_value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { "new_value": "abc123", - "old_value": "abc123", - "title": "abc123" + "old_value": "xyz789", + "title": "xyz789" } ``` @@ -611,8 +611,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -663,12 +663,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "xyz789"} +{"comment": "abc123"} ``` @@ -684,8 +684,8 @@ Contains details about a change for a negotiable quote. | `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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -728,8 +728,8 @@ Contains a new expiration date and the previous date. | Field Name | Description | |------------|-------------| -| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | +| `new_expiration` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example @@ -750,14 +750,14 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](/reference/graphql/2-4-6/types-f-i.md#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_catalog": [4], "products_removed_from_quote": [ProductInterface] } ``` @@ -831,12 +831,12 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -849,13 +849,13 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -{"quantity": 987.65, "quote_item_uid": 4} +{"quantity": 987.65, "quote_item_uid": "4"} ``` @@ -868,15 +868,15 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | Payment method code | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "code": "xyz789", - "purchase_order_number": "xyz789" + "code": "abc123", + "purchase_order_number": "abc123" } ``` @@ -888,17 +888,17 @@ Defines the payment method to be applied to the negotiable quote. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/2-4-6/types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `selected_shipping_method` - [`SelectedShippingMethod`](/reference/graphql/2-4-6/types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's telephone number. | #### Example @@ -909,12 +909,12 @@ Defines the payment method to be applied to the negotiable quote. "company": "abc123", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "telephone": "abc123" + "street": ["abc123"], + "telephone": "xyz789" } ``` @@ -929,16 +929,16 @@ Defines shipping addresses for the negotiable quote. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "customer_notes": "abc123" + "customer_address_uid": 4, + "customer_notes": "xyz789" } ``` @@ -952,7 +952,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1010,7 +1010,7 @@ Defines the field to use to sort a list of negotiable quotes. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1021,7 +1021,7 @@ Defines the field to use to sort a list of negotiable quotes. #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1034,12 +1034,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -1052,14 +1052,14 @@ A limited view of a Buyer or Seller in the negotiable quote process. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The buyer's or seller's last name. | #### Example ```json { - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123" } ``` @@ -1075,9 +1075,9 @@ Contains a list of negotiable that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-6/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1086,7 +1086,7 @@ Contains a list of negotiable that match the specified filter. "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } ``` @@ -1100,16 +1100,13 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | -| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json -{ - "message": "abc123", - "uid": "4" -} +{"message": "xyz789", "uid": 4} ``` @@ -1122,15 +1119,15 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json { "order_id": "xyz789", - "order_number": "abc123" + "order_number": "xyz789" } ``` @@ -1144,40 +1141,40 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | -| `fax` - [`String`](types-q-s.md#string) | The fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `city` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The city or town. | +| `company` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](/reference/graphql/2-4-6/types-c-e.md#countrycodeenum) | The customer's country. | +| `fax` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country_code": "AF", "fax": "abc123", "firstname": "xyz789", - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": "abc123", - "region_id": "4", - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", + "region_id": 4, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "abc123", "vat_id": "abc123" } ``` @@ -1190,25 +1187,25 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The status of the order item. | #### Example @@ -1219,15 +1216,15 @@ Contains detailed information about an order's billing and shipping addresses. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "xyz789", + "product_type": "abc123", "product_url_key": "abc123", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, "quantity_refunded": 123.45, "quantity_returned": 987.65, "quantity_shipped": 987.65, @@ -1246,33 +1243,33 @@ Order item details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | -| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | -| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | +| [`DownloadableOrderItem`](/reference/graphql/2-4-6/types-c-e.md#downloadableorderitem) | +| [`BundleOrderItem`](/reference/graphql/2-4-6/types-a-b.md#bundleorderitem) | +| [`GiftCardOrderItem`](/reference/graphql/2-4-6/types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1284,20 +1281,20 @@ Order item details. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "abc123", "product_url_key": "abc123", "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, + "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" + "status": "xyz789" } ``` @@ -1311,14 +1308,14 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The name of the option. | -| `value` - [`String!`](types-q-s.md#string) | The value of the option. | +| `label` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -1334,8 +1331,8 @@ Contains details about the payment method used to pay for the order. | Field Name | Description | |------------|-------------| | `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | -| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example @@ -1357,11 +1354,11 @@ Contains order shipment details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-6/types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](/reference/graphql/2-4-6/types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](/reference/graphql/2-4-6/types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example @@ -1370,7 +1367,7 @@ Contains order shipment details. "comments": [SalesCommentItem], "id": 4, "items": [ShipmentItemInterface], - "number": "abc123", + "number": "xyz789", "tracking": [ShipmentTracking] } ``` @@ -1386,11 +1383,11 @@ Contains details about the sales total amounts used to calculate the final price | Field Name | Description | |------------|-------------| | `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-6/types-c-e.md#discount) | The applied discounts to the order. | | `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the order. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-6/types-q-s.md#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]`](types-t-z.md#taxitem) | The order tax details. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-6/types-t-z.md#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. | @@ -1421,15 +1418,15 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { "payer_id": "xyz789", - "token": "abc123" + "token": "xyz789" } ``` @@ -1443,17 +1440,17 @@ A set of relative URLs that PayPal uses in response to various actions during th | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](/reference/graphql/2-4-6/types-q-s.md#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!`](/reference/graphql/2-4-6/types-q-s.md#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": "xyz789" + "cancel_url": "abc123", + "error_url": "abc123", + "return_url": "abc123" } ``` @@ -1487,9 +1484,9 @@ Contains information used to generate PayPal iframe for transaction. Applies to | Field Name | Description | |------------|-------------| | `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | +| `paypal_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example @@ -1498,7 +1495,7 @@ Contains information used to generate PayPal iframe for transaction. Applies to "mode": "TEST", "paypal_url": "abc123", "secure_token": "xyz789", - "secure_token_id": "xyz789" + "secure_token_id": "abc123" } ``` @@ -1512,12 +1509,12 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -1530,15 +1527,15 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | Input Field | Description | |-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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. | +| `cc_details` - [`CreditCardDetailsInput!`](/reference/graphql/2-4-6/types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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 + "is_active_payment_token_enabler": true } ``` @@ -1552,15 +1549,15 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The payload returned from PayPal. | #### Example ```json { "cart_id": "abc123", - "paypal_payload": "abc123" + "paypal_payload": "xyz789" } ``` @@ -1572,7 +1569,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -1590,14 +1587,14 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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", + "cart_id": "xyz789", "urls": PayflowProUrlInput } ``` @@ -1612,17 +1609,17 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](/reference/graphql/2-4-6/types-q-s.md#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!`](/reference/graphql/2-4-6/types-q-s.md#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": "xyz789", - "return_url": "xyz789" + "cancel_url": "xyz789", + "error_url": "abc123", + "return_url": "abc123" } ``` @@ -1636,16 +1633,16 @@ Defines the payment method. | Input Field | Description | |-------------|-------------| -| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | -| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](types-f-i.md#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `braintree` - [`BraintreeInput`](/reference/graphql/2-4-6/types-a-b.md#braintreeinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](/reference/graphql/2-4-6/types-a-b.md#braintreeccvaultinput) | | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](/reference/graphql/2-4-6/types-f-i.md#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`](types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payflowpro_cc_vault` - [`VaultTokenInput`](/reference/graphql/2-4-6/types-t-z.md#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`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `purchase_order_number` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -1674,18 +1671,18 @@ The stored payment method available to the customer. | Field Name | Description | |------------|-------------| -| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | +| `details` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "details": "abc123", - "payment_method_code": "xyz789", - "public_hash": "xyz789", + "details": "xyz789", + "payment_method_code": "abc123", + "public_hash": "abc123", "type": "card" } ``` @@ -1719,8 +1716,8 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example @@ -1741,19 +1738,19 @@ Defines the attributes required to receive a payment token for Express Checkout | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | -| `express_button` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | +| `use_paypal_credit` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { "cart_id": "abc123", - "code": "xyz789", - "express_button": true, + "code": "abc123", + "express_button": false, "urls": PaypalExpressUrlsInput, "use_paypal_credit": true } @@ -1770,7 +1767,7 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | Field Name | Description | |------------|-------------| | `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | +| `token` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The token returned by PayPal. | #### Example @@ -1791,14 +1788,14 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | Field Name | Description | |------------|-------------| -| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | +| `edit` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL to the PayPal login page. | #### Example ```json { - "edit": "abc123", + "edit": "xyz789", "start": "xyz789" } ``` @@ -1813,10 +1810,10 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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`](/reference/graphql/2-4-6/types-q-s.md#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!`](/reference/graphql/2-4-6/types-q-s.md#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`](/reference/graphql/2-4-6/types-q-s.md#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 @@ -1824,7 +1821,7 @@ Contains a set of relative URLs that PayPal uses in response to various actions { "cancel_url": "abc123", "pending_url": "xyz789", - "return_url": "abc123", + "return_url": "xyz789", "success_url": "abc123" } ``` @@ -1839,17 +1836,17 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Possible Types | PhysicalProductInterface Types | |----------------| -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-6/types-q-s.md#simpleproduct) | +| [`BundleProduct`](/reference/graphql/2-4-6/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-6/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-6/types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-6/types-c-e.md#configurableproduct) | #### Example @@ -1867,21 +1864,21 @@ Defines Pickup Location information. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | | -| `contact_name` - [`String`](types-q-s.md#string) | | -| `country_id` - [`String`](types-q-s.md#string) | | -| `description` - [`String`](types-q-s.md#string) | | -| `email` - [`String`](types-q-s.md#string) | | -| `fax` - [`String`](types-q-s.md#string) | | -| `latitude` - [`Float`](types-f-i.md#float) | | -| `longitude` - [`Float`](types-f-i.md#float) | | -| `name` - [`String`](types-q-s.md#string) | | -| `phone` - [`String`](types-q-s.md#string) | | -| `pickup_location_code` - [`String`](types-q-s.md#string) | | -| `postcode` - [`String`](types-q-s.md#string) | | -| `region` - [`String`](types-q-s.md#string) | | -| `region_id` - [`Int`](types-f-i.md#int) | | -| `street` - [`String`](types-q-s.md#string) | | +| `city` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `contact_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `country_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `email` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `fax` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `latitude` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | | +| `longitude` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `phone` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `pickup_location_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `postcode` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `region` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | +| `region_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | | +| `street` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | | #### Example @@ -1890,16 +1887,16 @@ Defines Pickup Location information. "city": "xyz789", "contact_name": "xyz789", "country_id": "abc123", - "description": "abc123", + "description": "xyz789", "email": "abc123", "fax": "xyz789", - "latitude": 987.65, - "longitude": 123.45, - "name": "xyz789", + "latitude": 123.45, + "longitude": 987.65, + "name": "abc123", "phone": "abc123", "pickup_location_code": "abc123", "postcode": "abc123", - "region": "abc123", + "region": "xyz789", "region_id": 123, "street": "abc123" } @@ -1915,14 +1912,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | Input Field | Description | |-------------|-------------| -| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | +| `city` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -1949,22 +1946,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | Input Field | Description | |-------------|-------------| -| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | -| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | +| `city` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#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`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2000,8 +1997,8 @@ Top level object returned in a pickup locations search. | Field Name | Description | |------------|-------------| | `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of products returned. | #### Example @@ -2009,7 +2006,7 @@ Top level object returned in a pickup locations search. { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2023,7 +2020,7 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2059,12 +2056,12 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json -{"purchase_order_uid": "4"} +{"purchase_order_uid": 4} ``` @@ -2077,7 +2074,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](/reference/graphql/2-4-6/types-c-e.md#customerorder) | Placed order. | #### Example @@ -2095,12 +2092,12 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -2131,12 +2128,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -2313,14 +2310,14 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | +| `code` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The display value of the attribute. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "value": "abc123" } ``` @@ -2335,36 +2332,36 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `activity` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Activity | -| `category_gear` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Category Gear | -| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `climate` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Climate | -| `collar` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Collar | -| `color` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Color | -| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | -| `eco_collection` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Eco Collection | -| `erin_recommends` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Erin Recommends | -| `features_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Features | -| `format` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Format | -| `gender` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Gender | -| `material` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Material | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | -| `new` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: New | -| `pattern` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Pattern | -| `performance_fabric` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Performance Fabric | -| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | -| `purpose` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Purpose | -| `sale` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sale | -| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | -| `size` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Size | -| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | -| `sleeve` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sleeve | -| `strap_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Strap/Handle | -| `style_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bags | -| `style_bottom` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bottom | -| `style_general` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style General | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | +| `activity` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Activity | +| `category_gear` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Category Gear | +| `category_id` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `climate` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Climate | +| `collar` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Collar | +| `color` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Color | +| `description` - [`FilterMatchTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `eco_collection` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Eco Collection | +| `erin_recommends` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Erin Recommends | +| `features_bags` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Features | +| `format` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Format | +| `gender` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Gender | +| `material` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Material | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `new` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: New | +| `pattern` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Pattern | +| `performance_fabric` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Performance Fabric | +| `price` - [`FilterRangeTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `purpose` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Purpose | +| `sale` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Sale | +| `short_description` - [`FilterMatchTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `size` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Size | +| `sku` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `sleeve` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Sleeve | +| `strap_bags` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Strap/Handle | +| `style_bags` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Style Bags | +| `style_bottom` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Style Bottom | +| `style_general` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Attribute label: Style General | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -2413,10 +2410,10 @@ Specifies the attribute to use for sorting search results and indicates whether | Input Field | Description | |-------------|-------------| -| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | +| `name` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](/reference/graphql/2-4-6/types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -2434,13 +2431,13 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | -| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The discount expressed a percentage. | #### Example ```json -{"amount_off": 123.45, "percent_off": 987.65} +{"amount_off": 123.45, "percent_off": 123.45} ``` @@ -2453,45 +2450,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | Input Field | Description | |-------------|-------------| -| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `category_id` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | +| `price` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -2549,19 +2546,19 @@ Contains product image information, including the image URL and label. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { - "disabled": true, + "disabled": false, "label": "abc123", "position": 987, - "url": "xyz789" + "url": "abc123" } ``` @@ -2575,7 +2572,7 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | +| `sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | Product SKU. | #### Example @@ -2593,103 +2590,103 @@ Contains fields that are common to all types of products. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `activity` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](/reference/graphql/2-4-6/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `is_returnable` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-6/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `purpose` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `review_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The total count of all the reviews given to the product. | | `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sale` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `special_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | | `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `strap_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of a swatch image. | | `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `type_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-6/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-6/types-t-z.md#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`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`VirtualProduct`](/reference/graphql/2-4-6/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-6/types-q-s.md#simpleproduct) | +| [`DownloadableProduct`](/reference/graphql/2-4-6/types-c-e.md#downloadableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-6/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-6/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-6/types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-6/types-c-e.md#configurableproduct) | #### Example ```json { - "activity": "abc123", + "activity": "xyz789", "attribute_set_id": 123, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "xyz789", + "category_gear": "abc123", "climate": "xyz789", - "collar": "xyz789", + "collar": "abc123", "color": 987, "country_of_manufacture": "xyz789", "created_at": "xyz789", @@ -2697,28 +2694,28 @@ Contains fields that are common to all types of products. "description": ComplexTextValue, "eco_collection": 987, "erin_recommends": 123, - "features_bags": "abc123", - "format": 123, + "features_bags": "xyz789", + "format": 987, "gender": "abc123", "gift_message_available": "abc123", - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 123, + "manufacturer": 987, "material": "abc123", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "name": "xyz789", + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "name": "abc123", "new": 987, - "new_from_date": "xyz789", + "new_from_date": "abc123", "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options_container": "xyz789", "pattern": "abc123", - "performance_fabric": 123, + "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -2726,9 +2723,9 @@ Contains fields that are common to all types of products. "purpose": 987, "rating_summary": 987.65, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, "size": 123, "sku": "abc123", @@ -2740,21 +2737,21 @@ Contains fields that are common to all types of products. "staged": false, "stock_status": "IN_STOCK", "strap_bags": "xyz789", - "style_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "xyz789", - "style_general": "xyz789", - "swatch_image": "xyz789", + "style_general": "abc123", + "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type_id": "xyz789", "uid": 4, - "updated_at": "abc123", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website] } ``` @@ -2769,21 +2766,21 @@ An implementation of `ProductLinksInterface`. | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { - "link_type": "xyz789", - "linked_product_sku": "abc123", + "link_type": "abc123", + "linked_product_sku": "xyz789", "linked_product_type": "xyz789", "position": 123, - "sku": "abc123" + "sku": "xyz789" } ``` @@ -2797,11 +2794,11 @@ Contains information about linked products, including the link type and product | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -2813,11 +2810,11 @@ Contains information about linked products, including the link type and product ```json { - "link_type": "xyz789", + "link_type": "abc123", "linked_product_sku": "abc123", - "linked_product_type": "abc123", + "linked_product_type": "xyz789", "position": 987, - "sku": "abc123" + "sku": "xyz789" } ``` @@ -2831,17 +2828,17 @@ Contains an image in base64 format and basic information about the image. | Field Name | Description | |------------|-------------| -| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | -| `name` - [`String`](types-q-s.md#string) | The file name of the image. | -| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | +| `base64_encoded_data` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "base64_encoded_data": "xyz789", - "name": "xyz789", - "type": "xyz789" + "base64_encoded_data": "abc123", + "name": "abc123", + "type": "abc123" } ``` @@ -2855,12 +2852,12 @@ Contains a link to a video file and basic information about the video. | Field Name | Description | |------------|-------------| -| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | -| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | -| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | -| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | -| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | -| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | +| `media_type` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL to the video. | #### Example @@ -2869,8 +2866,8 @@ Contains a link to a video file and basic information about the video. "media_type": "abc123", "video_description": "abc123", "video_metadata": "abc123", - "video_provider": "xyz789", - "video_title": "xyz789", + "video_provider": "abc123", + "video_title": "abc123", "video_url": "abc123" } ``` @@ -2887,7 +2884,7 @@ Represents a product price. |------------|-------------| | `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]`](types-f-i.md#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/2-4-6/types-f-i.md#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 @@ -2935,25 +2932,25 @@ Contains details of a product review. | Field Name | Description | |------------|-------------| -| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `average_rating` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `summary` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The review text. | #### Example ```json { - "average_rating": 987.65, - "created_at": "xyz789", - "nickname": "xyz789", + "average_rating": 123.45, + "created_at": "abc123", + "nickname": "abc123", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], "summary": "abc123", - "text": "xyz789" + "text": "abc123" } ``` @@ -2967,8 +2964,8 @@ Contains data about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example @@ -2989,8 +2986,8 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | An encoded rating value ID. | #### Example @@ -3011,16 +3008,16 @@ Contains details about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#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": "abc123", + "id": "abc123", + "name": "xyz789", "values": [ProductReviewRatingValueMetadata] } ``` @@ -3035,15 +3032,15 @@ Contains details about a single value in a product review. | Field Name | Description | |------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `value` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { - "value": "xyz789", - "value_id": "abc123" + "value": "abc123", + "value_id": "xyz789" } ``` @@ -3076,7 +3073,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -3116,21 +3113,21 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | Field Name | Description | |------------|-------------| -| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | +| `customer_group_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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": 123.45 + "customer_group_id": "abc123", + "percentage_value": 987.65, + "qty": 123.45, + "value": 123.45, + "website_id": 987.65 } ``` @@ -3144,17 +3141,17 @@ Contains information about a product video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json { - "disabled": true, + "disabled": false, "label": "abc123", "position": 123, "url": "abc123", @@ -3172,13 +3169,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](types-a-b.md#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](/reference/graphql/2-4-6/types-a-b.md#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`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-6/types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](/reference/graphql/2-4-6/types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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 @@ -3207,15 +3204,15 @@ Contains details about a purchase order. | `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!`](types-q-s.md#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](types-c-e.md#customer) | The company user who created the purchase order. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](/reference/graphql/2-4-6/types-c-e.md#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!`](types-q-s.md#string) | The purchase order number. | -| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](types-c-e.md#cart) | The quote related to the purchase order. | +| `number` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](/reference/graphql/2-4-6/types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](/reference/graphql/2-4-6/types-c-e.md#cart) | The quote related to the purchase order. | | `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -3224,7 +3221,7 @@ Contains details about a purchase order. "approval_flow": [PurchaseOrderRuleApprovalFlow], "available_actions": ["REJECT"], "comments": [PurchaseOrderComment], - "created_at": "xyz789", + "created_at": "abc123", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], "number": "abc123", @@ -3232,7 +3229,7 @@ Contains details about a purchase order. "quote": Cart, "status": "PENDING", "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -3266,13 +3263,13 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{"message": "xyz789", "type": "NOT_FOUND"} ``` @@ -3285,19 +3282,19 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | A formatted message. | -| `name` - [`String`](types-q-s.md#string) | The approver name. | -| `role` - [`String`](types-q-s.md#string) | The approver role. | +| `message` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A formatted message. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The approver name. | +| `role` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The approver role. | | `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { - "message": "xyz789", - "name": "abc123", - "role": "abc123", + "message": "abc123", + "name": "xyz789", + "role": "xyz789", "status": "PENDING", "updated_at": "abc123" } @@ -3331,16 +3328,16 @@ Contains details about a purchase order approval rule. | Field Name | Description | |------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `applies_to_roles` - [`[CompanyRole]!`](/reference/graphql/2-4-6/types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](/reference/graphql/2-4-6/types-c-e.md#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!`](types-q-s.md#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The name of the purchase order approval rule. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the purchase order approval rule. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -3351,10 +3348,10 @@ Contains details about a purchase order approval rule. "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "xyz789", - "description": "abc123", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "xyz789" } ``` @@ -3440,7 +3437,7 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | +| `quantity` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example @@ -3458,11 +3455,11 @@ Defines a new purchase order approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | +| `applies_to` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#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]!`](/reference/graphql/2-4-6/types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](/reference/graphql/2-4-6/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example @@ -3472,8 +3469,8 @@ Defines a new purchase order approval rule. "applies_to": ["4"], "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", - "name": "xyz789", + "description": "abc123", + "name": "abc123", "status": "ENABLED" } ``` @@ -3488,9 +3485,9 @@ Contains metadata that can be used to render rule edit forms. | Field Name | Description | |------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | +| `available_applies_to` - [`[CompanyRole]!`](/reference/graphql/2-4-6/types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](/reference/graphql/2-4-6/types-a-b.md#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]!`](/reference/graphql/2-4-6/types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -3548,8 +3545,8 @@ Contains the approval rules that the customer can see. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -3571,19 +3568,19 @@ Contains details about a comment. | Field Name | Description | |------------|-------------| -| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | -| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | +| `author` - [`Customer`](/reference/graphql/2-4-6/types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | A unique identifier of the comment. | #### Example ```json { "author": Customer, - "created_at": "xyz789", - "text": "abc123", - "uid": "4" + "created_at": "abc123", + "text": "xyz789", + "uid": 4 } ``` @@ -3617,17 +3614,17 @@ Contains details about a status change. | Field Name | Description | |------------|-------------| -| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | -| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | +| `activity` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "activity": "xyz789", - "created_at": "abc123", + "activity": "abc123", + "created_at": "xyz789", "message": "xyz789", "uid": 4 } @@ -3644,14 +3641,14 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | +| `rule_name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the applied rule. | #### Example ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "abc123" + "rule_name": "xyz789" } ``` @@ -3690,8 +3687,8 @@ Contains a list of purchase orders. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -3699,7 +3696,7 @@ Contains a list of purchase orders. { "items": [PurchaseOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -3713,12 +3710,12 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of of purchase order UIDs. | #### Example ```json -{"purchase_order_uids": ["4"]} +{"purchase_order_uids": [4]} ``` @@ -3753,18 +3750,18 @@ Defines the criteria to use to filter the list of purchase orders. | Input Field | Description | |-------------|-------------| -| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `company_purchase_orders` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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, + "company_purchase_orders": true, "created_date": FilterRangeTypeInput, - "require_my_approval": true, + "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 index da6c7fd25..196ce8329 100644 --- 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 @@ -7,16 +7,16 @@ | Field Name | Description | |------------|-------------| | `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "id": 987, - "name": "abc123" + "name": "xyz789" } ``` @@ -35,7 +35,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -48,7 +48,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -73,7 +73,7 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_card_code": "abc123" } ``` @@ -88,7 +88,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -106,7 +106,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -124,12 +124,12 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -142,7 +142,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -161,15 +161,15 @@ Specifies which items to remove from the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { "cart_id": "xyz789", - "cart_item_id": 987, + "cart_item_id": 123, "cart_item_uid": 4 } ``` @@ -184,7 +184,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -202,16 +202,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_item_uids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "quote_item_uids": ["4"], - "quote_uid": "4" -} +{"quote_item_uids": [4], "quote_uid": 4} ``` @@ -224,7 +221,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -242,13 +239,13 @@ Defines which products to remove from a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": ["4"], "uid": 4} +{"products": [4], "uid": "4"} ``` @@ -261,8 +258,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-6/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-6/types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -283,7 +280,7 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example @@ -319,7 +316,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -342,7 +339,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -355,7 +352,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -373,8 +370,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](/reference/graphql/2-4-6/types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -395,8 +392,8 @@ Defines properties of a negotiable quote request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `cart_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](/reference/graphql/2-4-6/types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -405,7 +402,7 @@ Defines properties of a negotiable quote request. { "cart_id": 4, "comment": NegotiableQuoteCommentInput, - "quote_name": "xyz789" + "quote_name": "abc123" } ``` @@ -419,7 +416,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -440,14 +437,14 @@ Contains information needed to start a return request. | `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!`](types-f-i.md#id) | The unique ID for a `Order` object. | +| `order_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { - "comment_text": "abc123", - "contact_email": "abc123", + "comment_text": "xyz789", + "contact_email": "xyz789", "items": [RequestReturnItemInput], "order_uid": "4" } @@ -463,9 +460,9 @@ Contains details about an item to be returned. | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](types-f-i.md#float) | The quantity of the item to be returned. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](/reference/graphql/2-4-6/types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#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 @@ -517,21 +514,21 @@ Defines the contents of a requisition list. |------------|-------------| | `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!`](types-f-i.md#int) | The number of items in the list. | +| `items_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "items": RequistionListItems, "items_count": 123, - "name": "abc123", + "name": "xyz789", "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -545,8 +542,8 @@ Defines requisition list filters. | Input Field | Description | |-------------|-------------| -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-6/types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -568,20 +565,20 @@ The interface for requisition list items. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for the requisition list item. | #### Possible Types | RequisitionListItemInterface Types | |----------------| | [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | +| [`VirtualRequisitionListItem`](/reference/graphql/2-4-6/types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](/reference/graphql/2-4-6/types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](/reference/graphql/2-4-6/types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](/reference/graphql/2-4-6/types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](/reference/graphql/2-4-6/types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -590,7 +587,7 @@ The interface for requisition list items. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -604,9 +601,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-6/types-c-e.md#enteredoptioninput) | Entered option IDs. | | `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -615,8 +612,8 @@ Defines the items to add. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 987.65, + "parent_sku": "abc123", + "quantity": 123.45, "selected_options": ["abc123"], "sku": "xyz789" } @@ -634,7 +631,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -642,7 +639,7 @@ Defines customer requisition lists. { "items": [RequisitionList], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -658,7 +655,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | +| `total_pages` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of pages returned. | #### Example @@ -686,10 +683,10 @@ Contains details about a return. | `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`](types-c-e.md#customerorder) | The order associated with the return. | +| `order` - [`CustomerOrder`](/reference/graphql/2-4-6/types-c-e.md#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!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -704,7 +701,7 @@ Contains details about a return. "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -721,7 +718,7 @@ Contains details about a return comment. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example @@ -729,8 +726,8 @@ Contains details about a return comment. { "author_name": "xyz789", "created_at": "xyz789", - "text": "xyz789", - "uid": 4 + "text": "abc123", + "uid": "4" } ``` @@ -745,15 +742,15 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example ```json { - "label": "abc123", - "uid": "4", + "label": "xyz789", + "uid": 4, "value": "xyz789" } ``` @@ -776,9 +773,9 @@ The customer information for the return. ```json { - "email": "abc123", - "firstname": "abc123", - "lastname": "abc123" + "email": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789" } ``` @@ -793,11 +790,11 @@ Contains details about a product being returned. | Field Name | Description | |------------|-------------| | `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item requested to be returned. | +| `order_item` - [`OrderItemInterface!`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of the item requested to be returned. | | `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -806,9 +803,9 @@ Contains details about a product being returned. "custom_attributes": [ReturnCustomAttribute], "order_item": OrderItemInterface, "quantity": 123.45, - "request_quantity": 987.65, + "request_quantity": 123.45, "status": "PENDING", - "uid": 4 + "uid": "4" } ``` @@ -867,7 +864,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `city` - [`String!`](#string) | The city for product returns. | | `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](types-c-e.md#country) | An object that defines the country for product returns. | +| `country` - [`Country!`](/reference/graphql/2-4-6/types-c-e.md#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. | @@ -880,10 +877,10 @@ Contains details about the shipping address used for receiving returned items. "city": "abc123", "contact_name": "xyz789", "country": Country, - "postcode": "abc123", + "postcode": "xyz789", "region": Region, - "street": ["xyz789"], - "telephone": "xyz789" + "street": ["abc123"], + "telephone": "abc123" } ``` @@ -898,7 +895,7 @@ Contains details about the carrier on a return. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example @@ -919,7 +916,7 @@ Contains shipping and tracking details. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -928,7 +925,7 @@ Contains shipping and tracking details. "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, "tracking_number": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -948,7 +945,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "abc123", "type": "INFORMATION"} +{"text": "xyz789", "type": "INFORMATION"} ``` @@ -1007,7 +1004,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | +| `total_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The total number of return requests. | #### Example @@ -1015,7 +1012,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1029,7 +1026,7 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example @@ -1071,13 +1068,13 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | -| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | +| `money` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The reward points amount in points. | #### Example ```json -{"money": Money, "points": 987.65} +{"money": Money, "points": 123.45} ``` @@ -1093,16 +1090,16 @@ Contain details about the reward points transaction. | `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!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | +| `points_change` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example ```json { "balance": RewardPointsAmount, - "change_reason": "abc123", + "change_reason": "xyz789", "date": "abc123", - "points_change": 123.45 + "points_change": 987.65 } ``` @@ -1138,13 +1135,13 @@ Contains details about customer's reward points rate. | Field Name | Description | |------------|-------------| -| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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. | +| `currency_amount` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#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!`](/reference/graphql/2-4-6/types-f-i.md#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} +{"currency_amount": 123.45, "points": 123.45} ``` @@ -1196,23 +1193,23 @@ Routable entities serve as the model for a rendered page. | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](types-c-e.md#cmspage) | -| [`CategoryTree`](types-c-e.md#categorytree) | -| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`CmsPage`](/reference/graphql/2-4-6/types-c-e.md#cmspage) | +| [`CategoryTree`](/reference/graphql/2-4-6/types-c-e.md#categorytree) | +| [`VirtualProduct`](/reference/graphql/2-4-6/types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](/reference/graphql/2-4-6/types-c-e.md#downloadableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-6/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-6/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-6/types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-6/types-c-e.md#configurableproduct) | #### Example @@ -1242,7 +1239,7 @@ Contains details about a comment. ```json { "message": "abc123", - "timestamp": "abc123" + "timestamp": "xyz789" } ``` @@ -1276,14 +1273,14 @@ Provides navigation for the query response. | Field Name | Description | |------------|-------------| -| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | -| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | +| `current_page` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 987, "page_size": 123, "total_pages": 123} +{"current_page": 123, "page_size": 987, "total_pages": 123} ``` @@ -1301,7 +1298,7 @@ A string that contains search suggestion #### Example ```json -{"search": "abc123"} +{"search": "xyz789"} ``` @@ -1314,17 +1311,17 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example ```json { - "id": 987, + "id": 123, "label": "abc123", "type": "abc123", "uid": 4, @@ -1342,19 +1339,19 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | Use `uid` instead | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | Use `uid` instead | | `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `price` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { - "id": 123, + "id": 987, "label": "xyz789", - "price": 987.65, + "price": 123.45, "quantity": 987.65, "uid": "4" } @@ -1370,23 +1367,23 @@ Contains details about a selected configurable option. | Field Name | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `configurable_product_option_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | | `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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_uid": "4", "configurable_product_option_value_uid": 4, "id": 123, "option_label": "xyz789", "value_id": 123, - "value_label": "abc123" + "value_label": "xyz789" } ``` @@ -1401,7 +1398,7 @@ Contains details about an attribute the buyer selected. | Input Field | Description | |-------------|-------------| | `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | -| `value` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | +| `value` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | #### Example @@ -1422,11 +1419,11 @@ Identifies a customized product that has been placed in a cart. | Field Name | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customizable option is required. | +| `customizable_option_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the customizable option is required. | | `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](types-f-i.md#int) | A value indicating the order to display this option. | +| `sort_order` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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. | @@ -1435,10 +1432,10 @@ Identifies a customized product that has been placed in a cart. ```json { "customizable_option_uid": "4", - "id": 123, + "id": 987, "is_required": false, - "label": "abc123", - "sort_order": 987, + "label": "xyz789", + "sort_order": 123, "type": "abc123", "values": [SelectedCustomizableOptionValue] } @@ -1454,10 +1451,10 @@ Identifies the value of the selected customized option. | Field Name | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `customizable_option_value_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | | `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](/reference/graphql/2-4-6/types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | | `value` - [`String!`](#string) | The text identifying the selected value. | #### Example @@ -1465,8 +1462,8 @@ Identifies the value of the selected customized option. ```json { "customizable_option_value_uid": "4", - "id": 987, - "label": "abc123", + "id": 123, + "label": "xyz789", "price": CartItemSelectedOptionValuePrice, "value": "xyz789" } @@ -1490,7 +1487,7 @@ Describes the payment method the shopper selected. ```json { - "code": "abc123", + "code": "xyz789", "purchase_order_number": "abc123", "title": "abc123" } @@ -1506,14 +1503,14 @@ Contains details about the selected shipping method and carrier. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#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!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `price_excl_tax` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1540,7 +1537,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](types-f-i.md#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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. | @@ -1593,8 +1590,8 @@ An output object that contains information about the recipient. ```json { - "email": "abc123", - "name": "abc123" + "email": "xyz789", + "name": "xyz789" } ``` @@ -1616,7 +1613,7 @@ Contains details about a recipient. ```json { "email": "abc123", - "name": "abc123" + "name": "xyz789" } ``` @@ -1639,8 +1636,8 @@ An output object that contains information about the sender. ```json { "email": "xyz789", - "message": "abc123", - "name": "xyz789" + "message": "xyz789", + "name": "abc123" } ``` @@ -1678,13 +1675,13 @@ Contains details about the configuration of the Email to a Friend feature. | Field Name | Description | |------------|-------------| -| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | +| `enabled_for_customers` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": true, "enabled_for_guests": true} +{"enabled_for_customers": false, "enabled_for_guests": false} ``` @@ -1697,8 +1694,8 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](/reference/graphql/2-4-6/types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1716,7 +1713,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -1734,7 +1731,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](/reference/graphql/2-4-6/types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -1742,7 +1739,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "abc123" + "cart_id": "xyz789" } ``` @@ -1756,7 +1753,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -1775,20 +1772,20 @@ Defines the gift options applied to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/2-4-6/types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "gift_message": GiftMessageInput, "gift_receipt_included": false, - "gift_wrapping_id": 4, - "printed_card_included": false + "gift_wrapping_id": "4", + "printed_card_included": true } ``` @@ -1802,7 +1799,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The modified cart object. | #### Example @@ -1842,7 +1839,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -1860,15 +1857,15 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](/reference/graphql/2-4-6/types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -1882,7 +1879,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -1900,8 +1897,8 @@ Defines the payment method of the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](/reference/graphql/2-4-6/types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1922,7 +1919,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -1940,15 +1937,15 @@ Defines the shipping address to assign to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| `customer_address_id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](/reference/graphql/2-4-6/types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "customer_address_id": 4, + "customer_address_id": "4", "quote_uid": "4", "shipping_addresses": [ NegotiableQuoteShippingAddressInput @@ -1966,7 +1963,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -1984,14 +1981,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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, + "quote_uid": "4", "shipping_methods": [ShippingMethodInput] } ``` @@ -2006,7 +2003,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2025,7 +2022,7 @@ Applies a payment method to the quote. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/2-4-6/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2047,7 +2044,7 @@ Applies a payment method to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/2-4-6/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2068,7 +2065,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2108,7 +2105,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2133,7 +2130,7 @@ Applies one or shipping methods to the cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_methods": [ShippingMethodInput] } ``` @@ -2148,7 +2145,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2173,8 +2170,8 @@ Defines a gift registry invitee. ```json { - "email": "xyz789", - "name": "xyz789" + "email": "abc123", + "name": "abc123" } ``` @@ -2188,7 +2185,7 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example @@ -2214,7 +2211,7 @@ Defines the sender of an invitation to view a gift registry. ```json { "message": "xyz789", - "name": "xyz789" + "name": "abc123" } ``` @@ -2245,12 +2242,12 @@ Defines whether bundle items must be shipped together. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of shipped items. | #### Example @@ -2258,7 +2255,7 @@ Defines whether bundle items must be shipped together. { "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "quantity_shipped": 987.65 @@ -2275,19 +2272,19 @@ Order shipment item details. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-6/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | -| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | +| [`BundleShipmentItem`](/reference/graphql/2-4-6/types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](/reference/graphql/2-4-6/types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example @@ -2298,8 +2295,8 @@ Order shipment item details. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 + "product_sku": "xyz789", + "quantity_shipped": 987.65 } ``` @@ -2321,7 +2318,7 @@ Contains order shipment tracking details. ```json { - "carrier": "xyz789", + "carrier": "abc123", "number": "xyz789", "title": "abc123" } @@ -2337,8 +2334,8 @@ Defines a single shipping address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `address` - [`CartAddressInput`](/reference/graphql/2-4-6/types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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. | @@ -2348,7 +2345,7 @@ Defines a single shipping address. { "address": CartAddressInput, "customer_address_id": 123, - "customer_notes": "abc123", + "customer_notes": "xyz789", "pickup_location_code": "abc123" } ``` @@ -2363,19 +2360,19 @@ Contains shipping addresses and methods. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | An array that lists the items in the cart. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/2-4-6/types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](/reference/graphql/2-4-6/types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](/reference/graphql/2-4-6/types-c-e.md#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!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `country` - [`CartAddressCountry!`](/reference/graphql/2-4-6/types-c-e.md#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`](types-f-i.md#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `items_weight` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `region` - [`CartAddressRegion`](/reference/graphql/2-4-6/types-c-e.md#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. | @@ -2390,20 +2387,20 @@ Contains shipping addresses and methods. "cart_items": [CartItemQuantity], "cart_items_v2": [CartItemInterface], "city": "abc123", - "company": "xyz789", + "company": "abc123", "country": CartAddressCountry, - "customer_notes": "abc123", - "firstname": "xyz789", + "customer_notes": "xyz789", + "firstname": "abc123", "items_weight": 123.45, "lastname": "abc123", - "pickup_location_code": "abc123", + "pickup_location_code": "xyz789", "postcode": "xyz789", "region": CartAddressRegion, "selected_shipping_method": SelectedShippingMethod, "street": ["abc123"], "telephone": "xyz789", "uid": "xyz789", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -2417,7 +2414,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of the discount. | #### Example @@ -2435,11 +2432,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](types-k-p.md#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The shipping amount, including tax. | | `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-6/types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The total amount for shipping. | #### Example @@ -2470,7 +2467,7 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "xyz789", + "carrier_code": "abc123", "method_code": "abc123" } ``` @@ -2485,16 +2482,16 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-6/types-f-i.md#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]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-6/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-6/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-6/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | | `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-6/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2508,8 +2505,8 @@ An implementation for simple product cart items. "id": "abc123", "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -2524,83 +2521,83 @@ Defines a simple product, which is tangible and is usually sold in single units | Field Name | Description | |------------|-------------| | `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `categories` - [`[CategoryInterface]`](/reference/graphql/2-4-6/types-c-e.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#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`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `manufacturer` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-6/types-k-p.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-6/types-c-e.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-6/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-6/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-6/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#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!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `review_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#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`](types-f-i.md#float) | The discounted price of the product. | +| `special_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The discounted price of the product. | | `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-6/types-k-p.md#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`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-6/types-t-z.md#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!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#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]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-6/types-t-z.md#urlrewrite) | URL rewrites list | | `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/2-4-6/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2608,18 +2605,18 @@ Defines a simple product, which is tangible and is usually sold in single units { "activity": "xyz789", "attribute_set_id": 123, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "abc123", - "collar": "abc123", + "category_gear": "xyz789", + "climate": "xyz789", + "collar": "xyz789", "color": 987, "country_of_manufacture": "abc123", "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, - "eco_collection": 987, - "erin_recommends": 987, + "eco_collection": 123, + "erin_recommends": 123, "features_bags": "abc123", "format": 987, "gender": "xyz789", @@ -2627,46 +2624,46 @@ Defines a simple product, which is tangible and is usually sold in single units "id": 987, "image": ProductImage, "is_returnable": "xyz789", - "manufacturer": 987, - "material": "abc123", + "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": 123, "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "xyz789", - "pattern": "xyz789", + "pattern": "abc123", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 987, - "rating_summary": 987.65, + "purpose": 123, + "rating_summary": 123.45, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, + "relative_url": "xyz789", + "review_count": 987, "reviews": ProductReviews, - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, "size": 123, - "sku": "abc123", - "sleeve": "abc123", + "sku": "xyz789", + "sleeve": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 987.65, - "special_to_date": "xyz789", + "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "xyz789", + "style_bags": "abc123", "style_bottom": "abc123", "style_general": "xyz789", "swatch_image": "xyz789", @@ -2676,12 +2673,12 @@ Defines a simple product, which is tangible and is usually sold in single units "type": "CMS_PAGE", "type_id": "abc123", "uid": 4, - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "abc123", - "url_path": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website], "weight": 123.45 } @@ -2697,8 +2694,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-6/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-6/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -2720,9 +2717,9 @@ Contains details about simple products added to a requisition list. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -2731,7 +2728,7 @@ Contains details about simple products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -2748,9 +2745,9 @@ Contains a simple 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!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -2758,7 +2755,7 @@ Contains a simple product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": "4", "product": ProductInterface, "quantity": 987.65 @@ -2801,7 +2798,7 @@ Defines a possible sort field. ```json { - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -2846,7 +2843,7 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `autocomplete_on_storefront` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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. | @@ -2856,17 +2853,17 @@ Contains information about a store's configuration. | `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`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-6/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-f-i.md#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_sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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. | @@ -2878,26 +2875,26 @@ Contains information about a store's configuration. | `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`](types-f-i.md#int) | Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes). | +| `demonotice` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | The default number of products per page in Grid View. | +| `grid_per_page` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_default_store` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_negotiable_quote_active` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-f-i.md#int) | The default number of products per page in List View. | +| `list_per_page` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](types-f-i.md#int) | The width of the logo image, in pixels. | +| `logo_height` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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. | @@ -2917,14 +2914,14 @@ Contains information about a store's configuration. | `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`](types-f-i.md#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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `root_category_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-6/types-f-i.md#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`. | @@ -2932,149 +2929,149 @@ Contains information about a store's configuration. | `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`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `show_cms_breadcrumbs` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-f-i.md#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`](types-f-i.md#int) | The store view sort order. | +| `store_sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | -| `website_id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `use_store_in_url` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_enable_for_specific_countries` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#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`](types-f-i.md#int) | A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout. | +| `zero_subtotal_sort_order` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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", + "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": "abc123", - "allow_items": "xyz789", - "allow_order": "xyz789", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": false, + "allow_gift_wrapping_on_order_items": "abc123", + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "abc123", + "allow_order": "abc123", + "allow_printed_card": "xyz789", + "autocomplete_on_storefront": true, "base_currency_code": "abc123", "base_link_url": "xyz789", - "base_media_url": "xyz789", + "base_media_url": "abc123", "base_static_url": "abc123", - "base_url": "abc123", + "base_url": "xyz789", "braintree_cc_vault_active": "xyz789", "cart_gift_wrapping": "xyz789", - "cart_printed_card": "abc123", - "catalog_default_sort_by": "xyz789", + "cart_printed_card": "xyz789", + "catalog_default_sort_by": "abc123", "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": 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_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, + "check_money_order_send_check_to": "xyz789", + "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", + "cms_no_route": "xyz789", + "code": "xyz789", + "configurable_thumbnail_source": "abc123", "copyright": "abc123", "default_description": "abc123", "default_display_currency_code": "xyz789", - "default_keywords": "xyz789", - "default_title": "abc123", + "default_keywords": "abc123", + "default_title": "xyz789", "demonotice": 123, - "enable_multiple_wishlists": "xyz789", + "enable_multiple_wishlists": "abc123", "front": "xyz789", "grid_per_page": 987, "grid_per_page_values": "xyz789", "head_includes": "xyz789", - "head_shortcut_icon": "xyz789", - "header_logo_src": "abc123", - "id": 123, - "is_default_store": false, - "is_default_store_group": true, - "is_negotiable_quote_active": true, - "is_requisition_list_active": "xyz789", + "head_shortcut_icon": "abc123", + "header_logo_src": "xyz789", + "id": 987, + "is_default_store": true, + "is_default_store_group": false, + "is_negotiable_quote_active": false, + "is_requisition_list_active": "abc123", "list_mode": "xyz789", "list_per_page": 123, - "list_per_page_values": "abc123", + "list_per_page_values": "xyz789", "locale": "abc123", - "logo_alt": "abc123", - "logo_height": 987, + "logo_alt": "xyz789", + "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": "xyz789", - "magento_reward_general_publish_history": "abc123", - "magento_reward_points_invitation_customer": "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": "xyz789", "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "xyz789", + "magento_reward_points_newsletter": "abc123", "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "xyz789", + "magento_reward_points_register": "abc123", "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", "maximum_number_of_wishlists": "abc123", "minimum_password_length": "abc123", - "no_route": "xyz789", + "no_route": "abc123", "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "xyz789", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "xyz789", "product_url_suffix": "xyz789", - "required_character_classes_number": "xyz789", + "required_character_classes_number": "abc123", "returns_enabled": "xyz789", - "root_category_id": 987, + "root_category_id": 123, "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "abc123", - "sales_printed_card": "abc123", - "secure_base_link_url": "xyz789", + "sales_gift_wrapping": "xyz789", + "sales_printed_card": "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": 987, - "store_code": 4, - "store_group_code": 4, + "store_code": "4", + "store_group_code": "4", "store_group_name": "abc123", "store_name": "abc123", "store_sort_order": 987, - "timezone": "abc123", - "title_prefix": "abc123", + "timezone": "xyz789", + "title_prefix": "xyz789", "title_separator": "abc123", - "title_suffix": "abc123", + "title_suffix": "xyz789", "use_store_in_url": false, "website_code": 4, - "website_id": 987, - "website_name": "abc123", - "weight_unit": "abc123", - "welcome": "xyz789", + "website_id": 123, + "website_name": "xyz789", + "weight_unit": "xyz789", + "welcome": "abc123", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", + "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": 987, "zero_subtotal_title": "abc123" } @@ -3090,11 +3087,11 @@ Indicates where an attribute can be displayed. | Field Name | Description | |------------|-------------| -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | +| `position` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](/reference/graphql/2-4-6/types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example @@ -3102,8 +3099,8 @@ Indicates where an attribute can be displayed. { "position": 987, "use_in_layered_navigation": "NO", - "use_in_product_listing": true, - "use_in_search_results_layered_navigation": true, + "use_in_product_listing": false, + "use_in_search_results_layered_navigation": false, "visible_on_catalog_pages": false } ``` @@ -3119,7 +3116,7 @@ represent free-form human-readable text. #### Example ```json -"xyz789" +"abc123" ``` @@ -3179,7 +3176,7 @@ Describes the swatch type and a value. ```json { "type": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -3197,9 +3194,9 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | -| [`TextSwatchData`](types-t-z.md#textswatchdata) | -| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | +| [`ImageSwatchData`](/reference/graphql/2-4-6/types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](/reference/graphql/2-4-6/types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](/reference/graphql/2-4-6/types-c-e.md#colorswatchdata) | #### Example @@ -3215,7 +3212,7 @@ Describes the swatch type and a value. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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.)* | @@ -3224,7 +3221,7 @@ Describes the swatch type and a value. ```json { - "items_count": 123, + "items_count": 987, "label": "abc123", "swatch_data": SwatchData, "value_string": "abc123" 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 index aa065af60..1cbd4f287 100644 --- 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 @@ -8,9 +8,9 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | -| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | +| `amount` - [`Money!`](/reference/graphql/2-4-6/types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A title that describes the tax. | #### Example @@ -18,7 +18,7 @@ Contains tax item details. { "amount": Money, "rate": 123.45, - "title": "xyz789" + "title": "abc123" } ``` @@ -30,12 +30,12 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -48,9 +48,9 @@ Defines a price based on the quantity purchased. | Field Name | Description | |------------|-------------| -| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | -| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | +| `discount` - [`ProductDiscount`](/reference/graphql/2-4-6/types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](/reference/graphql/2-4-6/types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -72,8 +72,8 @@ Modifies the specified items in the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | +| `cart_id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](/reference/graphql/2-4-6/types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example @@ -94,7 +94,7 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-6/types-c-e.md#cart) | The cart after updating products. | #### Example @@ -112,7 +112,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/2-4-6/types-c-e.md#company) | The updated company instance. | #### Example @@ -130,7 +130,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](/reference/graphql/2-4-6/types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -148,7 +148,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/2-4-6/types-c-e.md#company) | The updated company instance. | #### Example @@ -166,7 +166,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](/reference/graphql/2-4-6/types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -184,7 +184,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | +| `user` - [`Customer!`](/reference/graphql/2-4-6/types-c-e.md#customer) | The updated company user instance. | #### Example @@ -202,12 +202,12 @@ Defines updates to a `GiftRegistry` object. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | -| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-6/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](/reference/graphql/2-4-6/types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/2-4-6/types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](/reference/graphql/2-4-6/types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -234,17 +234,17 @@ Defines updates to an item in a gift registry. | Input Field | Description | |-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | +| `gift_registry_item_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { - "gift_registry_item_uid": 4, - "note": "xyz789", - "quantity": 123.45 + "gift_registry_item_uid": "4", + "note": "abc123", + "quantity": 987.65 } ``` @@ -258,7 +258,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -276,7 +276,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -294,11 +294,11 @@ Defines updates to an existing registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | -| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-6/types-f-i.md#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`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -309,8 +309,8 @@ Defines updates to an existing registrant. ], "email": "abc123", "firstname": "xyz789", - "gift_registry_registrant_uid": 4, - "lastname": "abc123" + "gift_registry_registrant_uid": "4", + "lastname": "xyz789" } ``` @@ -324,7 +324,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-6/types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -342,7 +342,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-6/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -360,15 +360,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](/reference/graphql/2-4-6/types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -404,23 +404,23 @@ Defines the changes to be made to an approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | -| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | +| `applies_to` - [`[ID]`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](/reference/graphql/2-4-6/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](/reference/graphql/2-4-6/types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { "applies_to": ["4"], - "approvers": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", - "name": "abc123", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", "uid": "4" } @@ -436,15 +436,15 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The new name of the requisition list. | #### Example ```json { - "description": "xyz789", - "name": "abc123" + "description": "abc123", + "name": "xyz789" } ``` @@ -458,18 +458,18 @@ Defines which items in a requisition list to update. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-6/types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](/reference/graphql/2-4-6/types-q-s.md#string) | An array of selected option IDs. | #### Example ```json { "entered_options": [EnteredOptionInput], - "item_id": 4, - "quantity": 123.45, + "item_id": "4", + "quantity": 987.65, "selected_options": ["xyz789"] } ``` @@ -484,7 +484,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -502,7 +502,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-6/types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -520,16 +520,16 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The wish list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#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, + "name": "abc123", + "uid": "4", "visibility": "PUBLIC" } ``` @@ -544,15 +544,15 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](types-q-s.md#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](/reference/graphql/2-4-6/types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The request URL. | #### Example ```json { "parameters": [HttpQueryParameter], - "url": "xyz789" + "url": "abc123" } ``` @@ -606,13 +606,13 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -645,12 +645,12 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of the purchase order IDs. | #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -664,7 +664,7 @@ Contains the results of validation attempts. | Field Name | Description | |------------|-------------| | `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | +| `purchase_orders` - [`[PurchaseOrder]!`](/reference/graphql/2-4-6/types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -685,7 +685,7 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The public hash of the payment token. | #### Example @@ -703,13 +703,13 @@ An implementation for virtual product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-6/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-6/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -717,11 +717,11 @@ An implementation for virtual product cart items. { "customizable_options": [SelectedCustomizableOption], "errors": [CartItemError], - "id": "abc123", + "id": "xyz789", "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -735,121 +735,121 @@ Defines a virtual product, which is a non-tangible product that does not require | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `activity` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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]`](/reference/graphql/2-4-6/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-6/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-6/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-6/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-6/types-k-p.md#pricerange) | The range of prices for the product | | `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-6/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-6/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-6/types-k-p.md#productreviews) | The list of products reviews. | +| `sale` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-6/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-6/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-6/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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]`](/reference/graphql/2-4-6/types-k-p.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `type_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | | `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `url_suffix` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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", + "activity": "xyz789", "attribute_set_id": 987, - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "xyz789", + "category_gear": "abc123", "climate": "abc123", "collar": "xyz789", "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", + "country_of_manufacture": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "description": ComplexTextValue, - "eco_collection": 987, - "erin_recommends": 987, + "eco_collection": 123, + "erin_recommends": 123, "features_bags": "xyz789", - "format": 987, + "format": 123, "gender": "abc123", - "gift_message_available": "abc123", - "id": 987, + "gift_message_available": "xyz789", + "id": 123, "image": ProductImage, "is_returnable": "xyz789", "manufacturer": 987, - "material": "abc123", + "material": "xyz789", "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "xyz789", + "meta_title": "abc123", "name": "abc123", - "new": 987, + "new": 123, "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", "pattern": "xyz789", @@ -858,28 +858,28 @@ Defines a virtual product, which is a non-tangible product that does not require "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 123, - "rating_summary": 123.45, - "redirect_code": 123, + "purpose": 987, + "rating_summary": 987.65, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "xyz789", "review_count": 987, "reviews": ProductReviews, - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, - "size": 123, + "size": 987, "sku": "abc123", "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": false, + "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": "xyz789", + "style_bags": "abc123", + "style_bottom": "abc123", + "style_general": "abc123", "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, @@ -887,10 +887,10 @@ Defines a virtual product, which is a non-tangible product that does not require "type": "CMS_PAGE", "type_id": "xyz789", "uid": "4", - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "xyz789", + "url_key": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website] @@ -907,8 +907,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-6/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-6/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -929,10 +929,10 @@ Contains details about virtual products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -940,7 +940,7 @@ Contains details about virtual products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -955,21 +955,21 @@ Contains a virtual product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": "4", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -985,12 +985,12 @@ Deprecated. It should not be used on the storefront. Contains information about | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](types-q-s.md#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`](types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | +| `code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](/reference/graphql/2-4-6/types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](/reference/graphql/2-4-6/types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | #### Example @@ -998,10 +998,10 @@ Deprecated. It should not be used on the storefront. Contains information about { "code": "abc123", "default_group_id": "xyz789", - "id": 987, - "is_default": false, + "id": 123, + "is_default": true, "name": "abc123", - "sort_order": 123 + "sort_order": 987 } ``` @@ -1016,7 +1016,7 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A localized error message. | #### Example @@ -1056,25 +1056,25 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `Wishlist` object. | | `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. | +| `items_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#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`](types-q-s.md#string) | The name of the wish list. | -| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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", + "id": 4, "items": [WishlistItem], "items_count": 123, "items_v2": WishlistItems, - "name": "abc123", - "sharing_code": "xyz789", + "name": "xyz789", + "sharing_code": "abc123", "updated_at": "abc123", "visibility": "PUBLIC" } @@ -1091,9 +1091,9 @@ Contains details about errors encountered when a customer added wish list items | Field Name | Description | |------------|-------------| | `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | +| `message` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example @@ -1137,21 +1137,21 @@ Contains details about a wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | +| `added_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { "added_at": "abc123", - "description": "abc123", - "id": 123, + "description": "xyz789", + "id": 987, "product": ProductInterface, - "qty": 123.45 + "qty": 987.65 } ``` @@ -1165,14 +1165,14 @@ Specifies the IDs of items to copy and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json { - "quantity": 123.45, + "quantity": 987.65, "wishlist_item_id": "4" } ``` @@ -1187,11 +1187,11 @@ Defines the items to add to a wish list. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-6/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | #### Example @@ -1201,7 +1201,7 @@ Defines the items to add to a wish list. "parent_sku": "abc123", "quantity": 123.45, "selected_options": ["4"], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -1215,33 +1215,33 @@ The interface for wish list items. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-6/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-6/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-6/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-6/types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | +| [`SimpleWishlistItem`](/reference/graphql/2-4-6/types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | -| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | -| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | -| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | +| [`DownloadableWishlistItem`](/reference/graphql/2-4-6/types-c-e.md#downloadablewishlistitem) | +| [`BundleWishlistItem`](/reference/graphql/2-4-6/types-a-b.md#bundlewishlistitem) | +| [`GiftCardWishlistItem`](/reference/graphql/2-4-6/types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](/reference/graphql/2-4-6/types-f-i.md#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](/reference/graphql/2-4-6/types-c-e.md#configurablewishlistitem) | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": "4", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -1257,13 +1257,13 @@ Specifies the IDs of the items to move and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#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!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json -{"quantity": 987.65, "wishlist_item_id": 4} +{"quantity": 123.45, "wishlist_item_id": 4} ``` @@ -1276,11 +1276,11 @@ Defines updates to items in a wish list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `description` - [`String`](/reference/graphql/2-4-6/types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-6/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](/reference/graphql/2-4-6/types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-6/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](/reference/graphql/2-4-6/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example @@ -1288,9 +1288,9 @@ Defines updates to items in a wish list. { "description": "abc123", "entered_options": [EnteredOptionInput], - "quantity": 987.65, - "selected_options": ["4"], - "wishlist_item_id": "4" + "quantity": 123.45, + "selected_options": [4], + "wishlist_item_id": 4 } ``` @@ -1305,7 +1305,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-6/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1327,19 +1327,19 @@ Deprecated: Use the `Wishlist` type instead. | 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`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-6/types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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`](/reference/graphql/2-4-6/types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-6/types-q-s.md#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", + "items_count": 987, + "name": "abc123", + "sharing_code": "abc123", "updated_at": "abc123" } ``` 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 914b59423..d1a1f58f6 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 @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](/reference/graphql/2-4-7/types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](/reference/graphql/2-4-7/types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": false}}} +{"data": {"acceptCompanyInvitation": {"success": true}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-7/types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -105,13 +105,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "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": 123, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -120,7 +120,7 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu ], "status": "xyz789", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -132,13 +132,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](/reference/graphql/2-4-7/types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -172,13 +172,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](/reference/graphql/2-4-7/types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -216,13 +216,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](/reference/graphql/2-4-7/types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -260,14 +260,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-7/types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](/reference/graphql/2-4-7/types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -293,7 +293,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -316,14 +316,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](/reference/graphql/2-4-7/types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -352,7 +352,7 @@ mutation addProductsToCart( ```json { - "cartId": "abc123", + "cartId": "xyz789", "cartItems": [CartItemInput] } ``` @@ -376,13 +376,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-7/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](/reference/graphql/2-4-7/types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -416,7 +416,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": 4 } @@ -430,14 +430,14 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](/reference/graphql/2-4-7/types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](/reference/graphql/2-4-7/types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -463,7 +463,7 @@ mutation addProductsToRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [RequisitionListItemsInput] } ``` @@ -486,14 +486,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](/reference/graphql/2-4-7/types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -521,10 +521,7 @@ mutation addProductsToWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItems": [WishlistItemInput] -} +{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} ``` ##### Response @@ -546,13 +543,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](/reference/graphql/2-4-7/types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](/reference/graphql/2-4-7/types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -592,13 +589,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](/reference/graphql/2-4-7/types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -642,14 +639,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -678,10 +675,7 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{ - "requisitionListUid": 4, - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -706,13 +700,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](/reference/graphql/2-4-7/types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](/reference/graphql/2-4-7/types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -746,13 +740,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](/reference/graphql/2-4-7/types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](/reference/graphql/2-4-7/types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -796,13 +790,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](/reference/graphql/2-4-7/types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -836,13 +830,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](/reference/graphql/2-4-7/types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -876,14 +870,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -912,7 +906,10 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": ["4"]} +{ + "wishlistId": "4", + "wishlistItemIds": ["4"] +} ``` ##### Response @@ -937,13 +934,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](/reference/graphql/2-4-7/types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -977,13 +974,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](/reference/graphql/2-4-7/types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1017,13 +1014,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](/reference/graphql/2-4-7/types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -1057,13 +1054,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -1097,13 +1094,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](/reference/graphql/2-4-7/types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](/reference/graphql/2-4-7/types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1137,13 +1134,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-7/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-7/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1187,13 +1184,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](/reference/graphql/2-4-7/types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1223,7 +1220,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": false + "result": true } } } @@ -1235,13 +1232,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -1331,15 +1328,15 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1351,13 +1348,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-7/types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1414,22 +1411,22 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "cancelNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "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, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, - "total_quantity": 123.45 + "status": "abc123", + "template_id": "4", + "total_quantity": 987.65 } } } @@ -1441,13 +1438,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/2-4-7/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](/reference/graphql/2-4-7/types-c-e.md#cancelorderinput) | | #### Example @@ -1489,13 +1486,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-7/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-7/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1539,14 +1536,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/2-4-7/types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | +| `currentPassword` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's updated password. | #### Example @@ -1673,24 +1670,24 @@ mutation changeCustomerPassword( "data": { "changeCustomerPassword": { "addresses": [CustomerAddress], - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], "date_of_birth": "xyz789", "default_billing": "xyz789", "default_shipping": "xyz789", "dob": "xyz789", - "email": "xyz789", - "firstname": "xyz789", - "gender": 123, + "email": "abc123", + "firstname": "abc123", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 987, + "group_id": 123, "id": 123, - "is_subscribed": true, + "is_subscribed": false, "job_title": "abc123", "lastname": "xyz789", "middlename": "xyz789", @@ -1710,11 +1707,11 @@ mutation changeCustomerPassword( "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "xyz789", - "taxvat": "abc123", + "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1729,13 +1726,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCartOutput!`](types-c-e.md#clearcartoutput) +**Response:** [`ClearCartOutput!`](/reference/graphql/2-4-7/types-c-e.md#clearcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ClearCartInput!`](types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | +| `input` - [`ClearCartInput!`](/reference/graphql/2-4-7/types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | #### Example @@ -1779,13 +1776,13 @@ mutation clearCart($input: ClearCartInput!) { Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](/reference/graphql/2-4-7/types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1805,7 +1802,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "xyz789"} +{"cartUid": "abc123"} ``` ##### Response @@ -1824,13 +1821,13 @@ mutation clearCustomerCart($cartUid: String!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](/reference/graphql/2-4-7/types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](/reference/graphql/2-4-7/types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1887,13 +1884,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-7/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](/reference/graphql/2-4-7/types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -1927,13 +1924,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) +**Response:** [`ContactUsOutput`](/reference/graphql/2-4-7/types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](/reference/graphql/2-4-7/types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -1965,15 +1962,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](/reference/graphql/2-4-7/types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](/reference/graphql/2-4-7/types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2025,15 +2022,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](/reference/graphql/2-4-7/types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2067,7 +2064,7 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, + "sourceWishlistUid": "4", "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } @@ -2093,7 +2090,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) #### Example @@ -2121,7 +2118,7 @@ mutation createBraintreeClientToken { Creates Client Token for Braintree PayPal Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) #### Example @@ -2138,7 +2135,7 @@ mutation createBraintreePayPalClientToken { ```json { "data": { - "createBraintreePayPalClientToken": "abc123" + "createBraintreePayPalClientToken": "xyz789" } } ``` @@ -2149,13 +2146,13 @@ mutation createBraintreePayPalClientToken { Creates Client Token for Braintree PayPal Vault Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `input` - [`BraintreeVaultInput`](/reference/graphql/2-4-7/types-a-b.md#braintreevaultinput) | | #### Example @@ -2189,13 +2186,13 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](/reference/graphql/2-4-7/types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](/reference/graphql/2-4-7/types-c-e.md#companycreateinput) | | #### Example @@ -2229,13 +2226,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](/reference/graphql/2-4-7/types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](/reference/graphql/2-4-7/types-c-e.md#companyrolecreateinput) | | #### Example @@ -2269,13 +2266,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](/reference/graphql/2-4-7/types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](/reference/graphql/2-4-7/types-c-e.md#companyteamcreateinput) | | #### Example @@ -2309,13 +2306,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](/reference/graphql/2-4-7/types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](/reference/graphql/2-4-7/types-c-e.md#companyusercreateinput) | | #### Example @@ -2349,13 +2346,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-7/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](/reference/graphql/2-4-7/types-c-e.md#createcomparelistinput) | | #### Example @@ -2389,9 +2386,9 @@ mutation createCompareList($input: CreateCompareListInput) { "data": { "createCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -2403,13 +2400,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-7/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](/reference/graphql/2-4-7/types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -2443,13 +2440,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/2-4-7/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](/reference/graphql/2-4-7/types-c-e.md#customeraddressinput) | | #### Example @@ -2511,23 +2508,23 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 123, - "default_billing": false, - "default_shipping": true, + "customer_id": 987, + "default_billing": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "xyz789", - "id": 987, + "firstname": "abc123", + "id": 123, "lastname": "xyz789", "middlename": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], + "region_id": 123, + "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "xyz789" + "telephone": "abc123", + "vat_id": "abc123" } } } @@ -2539,13 +2536,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-7/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](/reference/graphql/2-4-7/types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2583,13 +2580,13 @@ Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](types-q-s.md#string) +**Response:** [`String`](/reference/graphql/2-4-7/types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](/reference/graphql/2-4-7/types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2619,13 +2616,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](/reference/graphql/2-4-7/types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](/reference/graphql/2-4-7/types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2663,13 +2660,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](/reference/graphql/2-4-7/types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](/reference/graphql/2-4-7/types-c-e.md#createguestcartinput) | | #### Example @@ -2703,13 +2700,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](/reference/graphql/2-4-7/types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](/reference/graphql/2-4-7/types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -2739,11 +2736,11 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "xyz789", + "response_message": "abc123", "result": 987, - "result_code": 987, - "secure_token": "abc123", - "secure_token_id": "abc123" + "result_code": 123, + "secure_token": "xyz789", + "secure_token_id": "xyz789" } } } @@ -2755,13 +2752,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](/reference/graphql/2-4-7/types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](/reference/graphql/2-4-7/types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -2791,9 +2788,9 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 987.65, - "currency_code": "xyz789", - "id": "abc123", + "amount": 123.45, + "currency_code": "abc123", + "id": "xyz789", "mp_order_id": "abc123", "status": "xyz789" } @@ -2807,13 +2804,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](/reference/graphql/2-4-7/types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](/reference/graphql/2-4-7/types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2843,7 +2840,7 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { "data": { "createPaypalExpressToken": { "paypal_urls": PaypalExpressUrlList, - "token": "abc123" + "token": "xyz789" } } } @@ -2855,13 +2852,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](/reference/graphql/2-4-7/types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](/reference/graphql/2-4-7/types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -2899,13 +2896,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -2950,7 +2947,7 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "xyz789", - "created_by": "abc123", + "created_by": "xyz789", "description": "xyz789", "name": "abc123", "status": "ENABLED", @@ -2967,13 +2964,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](/reference/graphql/2-4-7/types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](/reference/graphql/2-4-7/types-c-e.md#createrequisitionlistinput) | | #### Example @@ -3013,13 +3010,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](/reference/graphql/2-4-7/types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](/reference/graphql/2-4-7/types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -3053,13 +3050,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](/reference/graphql/2-4-7/types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -3082,7 +3079,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyRole": {"success": true}}} +{"data": {"deleteCompanyRole": {"success": false}}} ``` @@ -3091,13 +3088,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](/reference/graphql/2-4-7/types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -3114,7 +3111,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3133,13 +3130,13 @@ Use deleteCompanyUserV2 instead. The current method only deactivates the user ac Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/2-4-7/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -3156,7 +3153,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3171,13 +3168,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/2-4-7/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -3194,13 +3191,13 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyUserV2": {"success": true}}} +{"data": {"deleteCompanyUserV2": {"success": false}}} ``` @@ -3209,13 +3206,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](/reference/graphql/2-4-7/types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3232,13 +3229,13 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response ```json -{"data": {"deleteCompareList": {"result": false}}} +{"data": {"deleteCompareList": {"result": true}}} ``` @@ -3247,7 +3244,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) #### Example @@ -3271,13 +3268,13 @@ mutation deleteCustomer { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3298,7 +3295,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": false}} +{"data": {"deleteCustomerAddress": true}} ``` @@ -3307,13 +3304,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete a negotiable quote template -**Response:** [`Boolean!`](types-a-b.md#boolean) +**Response:** [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-7/types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3343,13 +3340,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](/reference/graphql/2-4-7/types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](/reference/graphql/2-4-7/types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3402,13 +3399,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](/reference/graphql/2-4-7/types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3450,13 +3447,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](/reference/graphql/2-4-7/types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-7/types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3496,13 +3493,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](/reference/graphql/2-4-7/types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3522,7 +3519,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": "4"} +{"requisitionListUid": 4} ``` ##### Response @@ -3544,14 +3541,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](/reference/graphql/2-4-7/types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -3576,10 +3573,7 @@ mutation deleteRequisitionListItems( ##### Variables ```json -{ - "requisitionListUid": 4, - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -3600,13 +3594,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](/reference/graphql/2-4-7/types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -3648,13 +3642,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](/reference/graphql/2-4-7/types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](/reference/graphql/2-4-7/types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -3692,13 +3686,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](/reference/graphql/2-4-7/types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/2-4-7/types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -3743,13 +3737,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "estimateShippingMethods": [ { "amount": Money, - "available": false, + "available": true, "base_amount": Money, - "carrier_code": "xyz789", - "carrier_title": "abc123", - "error_message": "xyz789", + "carrier_code": "abc123", + "carrier_title": "xyz789", + "error_message": "abc123", "method_code": "abc123", - "method_title": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -3764,13 +3758,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](/reference/graphql/2-4-7/types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/2-4-7/types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -3804,14 +3798,14 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](types-c-e.md#customertoken) +**Response:** [`CustomerToken`](/reference/graphql/2-4-7/types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's password. | #### Example @@ -3858,13 +3852,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](/reference/graphql/2-4-7/types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](/reference/graphql/2-4-7/types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -3902,13 +3896,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](/reference/graphql/2-4-7/types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](/reference/graphql/2-4-7/types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -3946,13 +3940,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](/reference/graphql/2-4-7/types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](/reference/graphql/2-4-7/types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -3986,14 +3980,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | -| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | +| `source_cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4090,14 +4084,14 @@ mutation mergeCarts( "billing_address": BillingCartAddress, "email": "abc123", "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": true, + "printed_card_included": false, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 987.65 @@ -4112,14 +4106,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-7/types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4148,7 +4142,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": "4", "giftRegistryUid": 4} +{"cartUid": 4, "giftRegistryUid": 4} ``` ##### Response @@ -4158,7 +4152,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } } @@ -4171,15 +4165,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](/reference/graphql/2-4-7/types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](/reference/graphql/2-4-7/types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4210,7 +4204,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", + "sourceRequisitionListUid": 4, "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } @@ -4235,13 +4229,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](/reference/graphql/2-4-7/types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](/reference/graphql/2-4-7/types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4281,15 +4275,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](/reference/graphql/2-4-7/types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4324,7 +4318,7 @@ mutation moveProductsBetweenWishlists( ```json { "sourceWishlistUid": 4, - "destinationWishlistUid": 4, + "destinationWishlistUid": "4", "wishlistItems": [WishlistItemMoveInput] } ``` @@ -4349,13 +4343,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-7/types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4412,7 +4406,7 @@ 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": true, @@ -4426,7 +4420,7 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -4439,13 +4433,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](/reference/graphql/2-4-7/types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](/reference/graphql/2-4-7/types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4479,13 +4473,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/2-4-7/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](/reference/graphql/2-4-7/types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4533,13 +4527,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](/reference/graphql/2-4-7/types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](/reference/graphql/2-4-7/types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -4577,13 +4571,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](/reference/graphql/2-4-7/types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](/reference/graphql/2-4-7/types-k-p.md#placepurchaseorderinput) | | #### Example @@ -4623,13 +4617,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/2-4-7/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/2-4-7/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -4673,13 +4667,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-7/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-7/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -4723,13 +4717,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/2-4-7/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](/reference/graphql/2-4-7/types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4763,13 +4757,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/2-4-7/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](/reference/graphql/2-4-7/types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4803,13 +4797,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](/reference/graphql/2-4-7/types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](/reference/graphql/2-4-7/types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -4843,13 +4837,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](/reference/graphql/2-4-7/types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -4881,14 +4875,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](/reference/graphql/2-4-7/types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -4937,14 +4931,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-7/types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -4970,8 +4964,8 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, - "registrantsUid": ["4"] + "giftRegistryUid": "4", + "registrantsUid": [4] } ``` @@ -4993,13 +4987,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](/reference/graphql/2-4-7/types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](/reference/graphql/2-4-7/types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5033,13 +5027,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](/reference/graphql/2-4-7/types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](/reference/graphql/2-4-7/types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5079,13 +5073,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](/reference/graphql/2-4-7/types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5142,22 +5136,22 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -5169,13 +5163,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-7/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](/reference/graphql/2-4-7/types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5209,9 +5203,9 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -5223,14 +5217,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](/reference/graphql/2-4-7/types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5258,10 +5252,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemsIds": ["4"] -} +{"wishlistId": 4, "wishlistItemsIds": [4]} ``` ##### Response @@ -5283,13 +5274,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](/reference/graphql/2-4-7/types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](/reference/graphql/2-4-7/types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5323,13 +5314,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](/reference/graphql/2-4-7/types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -5363,13 +5354,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](/reference/graphql/2-4-7/types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](/reference/graphql/2-4-7/types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5403,13 +5394,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](/reference/graphql/2-4-7/types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](/reference/graphql/2-4-7/types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5447,13 +5438,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](/reference/graphql/2-4-7/types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](types-q-s.md#string) | | +| `orderNumber` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -5497,13 +5488,13 @@ mutation reorderItems($orderNumber: String!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](/reference/graphql/2-4-7/types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](/reference/graphql/2-4-7/types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -5541,13 +5532,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-7/types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -5606,18 +5597,18 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", "total_quantity": 987.65 } @@ -5631,13 +5622,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's email address. | #### Example @@ -5658,7 +5649,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Response ```json -{"data": {"requestPasswordResetEmail": false}} +{"data": {"requestPasswordResetEmail": true}} ``` @@ -5667,13 +5658,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/2-4-7/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](/reference/graphql/2-4-7/types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -5717,15 +5708,15 @@ mutation requestReturn($input: RequestReturnInput!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's new password. | #### Example @@ -5749,8 +5740,8 @@ mutation resetPassword( ```json { - "email": "xyz789", - "resetPasswordToken": "xyz789", + "email": "abc123", + "resetPasswordToken": "abc123", "newPassword": "xyz789" } ``` @@ -5767,7 +5758,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](/reference/graphql/2-4-7/types-q-s.md#revokecustomertokenoutput) #### Example @@ -5784,7 +5775,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": true}}} +{"data": {"revokeCustomerToken": {"result": false}}} ``` @@ -5793,13 +5784,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](/reference/graphql/2-4-7/types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](/reference/graphql/2-4-7/types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -5843,13 +5834,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](/reference/graphql/2-4-7/types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](/reference/graphql/2-4-7/types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -5889,13 +5880,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](/reference/graphql/2-4-7/types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](/reference/graphql/2-4-7/types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -5929,13 +5920,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](/reference/graphql/2-4-7/types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](/reference/graphql/2-4-7/types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -5969,13 +5960,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](/reference/graphql/2-4-7/types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](/reference/graphql/2-4-7/types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6009,13 +6000,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](/reference/graphql/2-4-7/types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](/reference/graphql/2-4-7/types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6049,13 +6040,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6095,13 +6086,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6141,13 +6132,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6187,13 +6178,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6233,13 +6224,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/2-4-7/types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6296,21 +6287,21 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": 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, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", + "template_id": 4, "total_quantity": 987.65 } } @@ -6327,13 +6318,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/2-4-7/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](/reference/graphql/2-4-7/types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -6381,13 +6372,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](/reference/graphql/2-4-7/types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](/reference/graphql/2-4-7/types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -6421,13 +6412,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](/reference/graphql/2-4-7/types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -6486,8 +6477,8 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": false, + "is_min_max_qty_used": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 123, @@ -6498,8 +6489,8 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 987.65 + "template_id": "4", + "total_quantity": 123.45 } } } @@ -6511,13 +6502,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](/reference/graphql/2-4-7/types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](/reference/graphql/2-4-7/types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -6551,13 +6542,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](/reference/graphql/2-4-7/types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](/reference/graphql/2-4-7/types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -6591,15 +6582,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](/reference/graphql/2-4-7/types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](/reference/graphql/2-4-7/types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](/reference/graphql/2-4-7/types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -6625,7 +6616,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -6643,13 +6634,13 @@ mutation shareGiftRegistry( Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](/reference/graphql/2-4-7/types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -6709,9 +6700,9 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "expiration_date": "abc123", "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": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -6719,8 +6710,8 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, + "status": "xyz789", + "template_id": "4", "total_quantity": 987.65 } } @@ -6733,13 +6724,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](/reference/graphql/2-4-7/types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -6756,7 +6747,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -6771,13 +6762,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](/reference/graphql/2-4-7/types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -6807,13 +6798,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](/reference/graphql/2-4-7/types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](/reference/graphql/2-4-7/types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -6847,13 +6838,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](/reference/graphql/2-4-7/types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](/reference/graphql/2-4-7/types-c-e.md#companyupdateinput) | | #### Example @@ -6887,13 +6878,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](/reference/graphql/2-4-7/types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](/reference/graphql/2-4-7/types-c-e.md#companyroleupdateinput) | | #### Example @@ -6927,13 +6918,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](/reference/graphql/2-4-7/types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](/reference/graphql/2-4-7/types-c-e.md#companystructureupdateinput) | | #### Example @@ -6967,13 +6958,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](/reference/graphql/2-4-7/types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](/reference/graphql/2-4-7/types-c-e.md#companyteamupdateinput) | | #### Example @@ -7007,13 +6998,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](/reference/graphql/2-4-7/types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](/reference/graphql/2-4-7/types-c-e.md#companyuserupdateinput) | | #### Example @@ -7047,13 +7038,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-7/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](/reference/graphql/2-4-7/types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7087,14 +7078,14 @@ mutation updateCustomer($input: CustomerInput!) { Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/2-4-7/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](/reference/graphql/2-4-7/types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7159,26 +7150,26 @@ mutation updateCustomerAddress( "city": "xyz789", "company": "xyz789", "country_code": "AF", - "country_id": "abc123", + "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, "default_billing": false, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "abc123", - "id": 987, + "firstname": "xyz789", + "id": 123, "lastname": "xyz789", "middlename": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "xyz789", - "vat_id": "xyz789" + "vat_id": "abc123" } } } @@ -7190,14 +7181,14 @@ mutation updateCustomerAddress( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-7/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's password. | #### Example @@ -7224,7 +7215,7 @@ mutation updateCustomerEmail( ```json { "email": "abc123", - "password": "xyz789" + "password": "abc123" } ``` @@ -7240,13 +7231,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-7/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](/reference/graphql/2-4-7/types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7280,14 +7271,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](/reference/graphql/2-4-7/types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](/reference/graphql/2-4-7/types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -7334,14 +7325,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](/reference/graphql/2-4-7/types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](/reference/graphql/2-4-7/types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -7390,14 +7381,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-7/types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](/reference/graphql/2-4-7/types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -7446,13 +7437,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](/reference/graphql/2-4-7/types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](/reference/graphql/2-4-7/types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -7492,13 +7483,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](/reference/graphql/2-4-7/types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](/reference/graphql/2-4-7/types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -7538,14 +7529,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](/reference/graphql/2-4-7/types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -7598,13 +7589,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-7/types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -7648,8 +7639,8 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "abc123", + "created_at": "xyz789", + "created_by": "xyz789", "description": "xyz789", "name": "xyz789", "status": "ENABLED", @@ -7666,14 +7657,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](/reference/graphql/2-4-7/types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](/reference/graphql/2-4-7/types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -7722,14 +7713,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](/reference/graphql/2-4-7/types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](/reference/graphql/2-4-7/types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -7755,7 +7746,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [ UpdateRequisitionListItemsInput ] @@ -7780,15 +7771,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](/reference/graphql/2-4-7/types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](/reference/graphql/2-4-7/types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -7828,8 +7819,8 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "abc123", - "uid": 4, + "name": "xyz789", + "uid": "4", "visibility": "PUBLIC" } } @@ -7842,13 +7833,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](/reference/graphql/2-4-7/types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](/reference/graphql/2-4-7/types-t-z.md#validatepurchaseordersinput) | | #### Example 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 ac3776353..5e99ffa64 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) +**Response:** [`AttributesFormOutput!`](/reference/graphql/2-4-7/types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](types-q-s.md#string) | Form code. | +| `formCode` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Form code. | #### Example @@ -70,14 +70,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](/reference/graphql/2-4-7/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-7/types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](/reference/graphql/2-4-7/types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -130,13 +130,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) +**Response:** [`[StoreConfig]`](/reference/graphql/2-4-7/types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -384,62 +384,62 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "absolute_footer": "xyz789", + "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": "xyz789", + "allow_items": "abc123", "allow_order": "xyz789", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, - "base_currency_code": "xyz789", - "base_link_url": "abc123", - "base_media_url": "abc123", - "base_static_url": "abc123", + "autocomplete_on_storefront": true, + "base_currency_code": "abc123", + "base_link_url": "xyz789", + "base_media_url": "xyz789", + "base_static_url": "xyz789", "base_url": "abc123", - "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_allowspecific": false, "braintree_3dsecure_always_request_3ds": true, "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "abc123", - "braintree_3dsecure_verify_3dsecure": true, + "braintree_3dsecure_verify_3dsecure": false, "braintree_ach_direct_debit_vault_active": true, - "braintree_applepay_merchant_name": "abc123", + "braintree_applepay_merchant_name": "xyz789", "braintree_applepay_vault_active": true, - "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_active": "abc123", "braintree_cc_vault_cvv": false, "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "xyz789", - "braintree_googlepay_cctypes": "xyz789", + "braintree_googlepay_btn_color": "abc123", + "braintree_googlepay_cctypes": "abc123", "braintree_googlepay_merchant_id": "xyz789", - "braintree_googlepay_vault_active": false, - "braintree_local_payment_allowed_methods": "abc123", + "braintree_googlepay_vault_active": true, + "braintree_local_payment_allowed_methods": "xyz789", "braintree_local_payment_fallback_button_text": "xyz789", - "braintree_local_payment_redirect_on_fail": "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": "xyz789", - "braintree_paypal_button_location_cart_type_credit_show": false, - "braintree_paypal_button_location_cart_type_messaging_layout": "abc123", + "braintree_paypal_button_location_cart_type_credit_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": 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_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_cart_type_messaging_show": false, + "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123", "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", - "braintree_paypal_button_location_cart_type_paylater_label": "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_paylater_label": "abc123", + "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_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": "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": true, - "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", + "braintree_paypal_button_location_checkout_type_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": "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", @@ -450,57 +450,57 @@ query availableStores($useCurrentGroup: Boolean) { "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": true, + "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_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": "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": "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_messaging_text_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": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_show": false, - "braintree_paypal_button_location_productpage_type_paypal_color": "abc123", + "braintree_paypal_button_location_productpage_type_paypal_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_shape": "abc123", "braintree_paypal_button_location_productpage_type_paypal_show": false, - "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_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": false, "braintree_paypal_send_cart_line_items": true, "braintree_paypal_vault_active": false, - "cart_expires_in_days": 123, + "cart_expires_in_days": 987, "cart_gift_wrapping": "xyz789", - "cart_printed_card": "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": "abc123", - "check_money_order_max_order_total": "xyz789", - "check_money_order_min_order_total": "abc123", - "check_money_order_new_order_status": "xyz789", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "abc123", + "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": "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": "xyz789", - "cms_home_page": "abc123", - "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", + "check_money_order_title": "abc123", + "cms_home_page": "xyz789", + "cms_no_cookies": "abc123", + "cms_no_route": "xyz789", "code": "abc123", - "configurable_thumbnail_source": "abc123", - "contact_enabled": true, + "configurable_thumbnail_source": "xyz789", + "contact_enabled": false, "copyright": "abc123", "countries_with_required_region": "xyz789", - "create_account_confirmation": false, + "create_account_confirmation": true, "customer_access_token_lifetime": 987.65, "default_country": "xyz789", "default_description": "xyz789", @@ -508,9 +508,9 @@ query availableStores($useCurrentGroup: Boolean) { "default_keywords": "xyz789", "default_title": "abc123", "demonotice": 123, - "display_state_if_optional": true, + "display_state_if_optional": false, "enable_multiple_wishlists": "abc123", - "front": "xyz789", + "front": "abc123", "grid_per_page": 987, "grid_per_page_values": "xyz789", "head_includes": "xyz789", @@ -518,51 +518,51 @@ query availableStores($useCurrentGroup: Boolean) { "header_logo_src": "xyz789", "id": 123, "is_default_store": true, - "is_default_store_group": false, + "is_default_store_group": true, "is_guest_checkout_enabled": false, "is_negotiable_quote_active": false, "is_one_page_checkout_enabled": true, "is_requisition_list_active": "abc123", "list_mode": "abc123", - "list_per_page": 123, + "list_per_page": 987, "list_per_page_values": "xyz789", - "locale": "abc123", - "logo_alt": "abc123", - "logo_height": 123, - "logo_width": 987, - "magento_reward_general_is_enabled": "abc123", + "locale": "xyz789", + "logo_alt": "xyz789", + "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": "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": "abc123", - "magento_reward_points_order": "abc123", + "magento_reward_points_invitation_order": "abc123", + "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": "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, + "minicart_display": true, "minicart_max_items": 987, - "minimum_password_length": "xyz789", + "minimum_password_length": "abc123", "newsletter_enabled": true, - "no_route": "abc123", - "optional_zip_countries": "abc123", - "order_cancellation_enabled": false, + "no_route": "xyz789", + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": true, "order_cancellation_reasons": [ CancellationReason ], - "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "xyz789", + "payment_payflowpro_cc_vault_active": "abc123", + "printed_card_price": "abc123", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", + "product_reviews_enabled": "abc123", "product_url_suffix": "xyz789", - "quickorder_active": true, - "required_character_classes_number": "xyz789", + "quickorder_active": false, + "required_character_classes_number": "abc123", "returns_enabled": "abc123", "root_category_id": 123, "root_category_uid": 4, @@ -571,26 +571,26 @@ query availableStores($useCurrentGroup: Boolean) { "sales_printed_card": "abc123", "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_static_url": "abc123", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "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_full_summary": false, + "shopping_cart_display_grand_total": false, + "shopping_cart_display_price": 123, + "shopping_cart_display_shipping": 987, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, + "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 987, - "store_code": 4, - "store_group_code": "4", + "store_code": "4", + "store_group_code": 4, "store_group_name": "abc123", - "store_name": "abc123", + "store_name": "xyz789", "store_sort_order": 987, "timezone": "xyz789", "title_prefix": "abc123", - "title_separator": "abc123", - "title_suffix": "xyz789", + "title_separator": "xyz789", + "title_suffix": "abc123", "use_store_in_url": true, "website_code": 4, "website_id": 123, @@ -600,7 +600,7 @@ query availableStores($useCurrentGroup: Boolean) { "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_action": "abc123", "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 987, "zero_subtotal_title": "xyz789" @@ -616,13 +616,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](types-c-e.md#cart) +**Response:** [`Cart`](/reference/graphql/2-4-7/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -708,19 +708,19 @@ 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, + "id": "4", + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -732,15 +732,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](types-c-e.md#categoryresult) +**Response:** [`CategoryResult`](/reference/graphql/2-4-7/types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/2-4-7/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -786,7 +786,7 @@ query categories( "categories": { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -802,13 +802,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](types-c-e.md#categorytree) +**Response:** [`CategoryTree`](/reference/graphql/2-4-7/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -869,7 +869,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 987} +{"id": 123} ``` ##### Response @@ -878,10 +878,10 @@ 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", + "canonical_url": "abc123", "children": [CategoryTree], "children_count": "xyz789", "cms_block": CmsBlock, @@ -891,30 +891,30 @@ query category($id: Int) { "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 987.65, - "id": 987, - "image": "abc123", + "id": 123, + "image": "xyz789", "include_in_menu": 987, "is_anchor": 123, "landing_page": 987, - "level": 123, - "meta_description": "xyz789", + "level": 987, + "meta_description": "abc123", "meta_keywords": "abc123", - "meta_title": "xyz789", + "meta_title": "abc123", "name": "abc123", - "path": "xyz789", + "path": "abc123", "path_in_store": "xyz789", "position": 987, - "product_count": 123, + "product_count": 987, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "xyz789", - "staged": true, + "staged": false, "type": "CMS_PAGE", - "uid": 4, + "uid": "4", "updated_at": "xyz789", - "url_key": "abc123", + "url_key": "xyz789", "url_path": "abc123", - "url_suffix": "abc123" + "url_suffix": "xyz789" } } } @@ -930,15 +930,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) +**Response:** [`[CategoryTree]`](/reference/graphql/2-4-7/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/2-4-7/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -1024,40 +1024,40 @@ query categoryList( "automatic_sorting": "xyz789", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children": [CategoryTree], "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "abc123", + "created_at": "xyz789", "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", + "default_sort_by": "abc123", "description": "abc123", "display_mode": "xyz789", - "filter_price_range": 123.45, - "id": 987, + "filter_price_range": 987.65, + "id": 123, "image": "xyz789", - "include_in_menu": 123, + "include_in_menu": 987, "is_anchor": 123, "landing_page": 987, "level": 987, - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", + "meta_title": "xyz789", + "name": "xyz789", "path": "xyz789", "path_in_store": "abc123", - "position": 123, + "position": 987, "product_count": 123, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", - "staged": false, + "staged": true, "type": "CMS_PAGE", - "uid": "4", + "uid": 4, "updated_at": "abc123", "url_key": "abc123", - "url_path": "xyz789", - "url_suffix": "abc123" + "url_path": "abc123", + "url_suffix": "xyz789" } ] } @@ -1070,7 +1070,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](/reference/graphql/2-4-7/types-c-e.md#checkoutagreement) #### Example @@ -1100,7 +1100,7 @@ query checkoutAgreements { "agreement_id": 987, "checkbox_text": "xyz789", "content": "abc123", - "content_height": "abc123", + "content_height": "xyz789", "is_html": false, "mode": "AUTO", "name": "xyz789" @@ -1116,13 +1116,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) +**Response:** [`CmsBlocks`](/reference/graphql/2-4-7/types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -1141,7 +1141,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["abc123"]} +{"identifiers": ["xyz789"]} ``` ##### Response @@ -1156,14 +1156,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](types-c-e.md#cmspage) +**Response:** [`CmsPage`](/reference/graphql/2-4-7/types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -1197,7 +1197,7 @@ query cmsPage( ##### Variables ```json -{"id": 123, "identifier": "abc123"} +{"id": 987, "identifier": "abc123"} ``` ##### Response @@ -1207,17 +1207,17 @@ query cmsPage( "data": { "cmsPage": { "content": "abc123", - "content_heading": "abc123", - "identifier": "abc123", - "meta_description": "xyz789", + "content_heading": "xyz789", + "identifier": "xyz789", + "meta_description": "abc123", "meta_keywords": "xyz789", - "meta_title": "abc123", - "page_layout": "abc123", - "redirect_code": 123, + "meta_title": "xyz789", + "page_layout": "xyz789", + "redirect_code": 987, "relative_url": "xyz789", - "title": "abc123", + "title": "xyz789", "type": "CMS_PAGE", - "url_key": "abc123" + "url_key": "xyz789" } } } @@ -1229,7 +1229,7 @@ query cmsPage( Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](types-c-e.md#company) +**Response:** [`Company`](/reference/graphql/2-4-7/types-c-e.md#company) #### Example @@ -1295,10 +1295,10 @@ 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": ["abc123"], "reseller_id": "xyz789", @@ -1309,7 +1309,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } } } @@ -1321,13 +1321,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-7/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1361,9 +1361,9 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -1375,7 +1375,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](types-c-e.md#country) +**Response:** [`[Country]`](/reference/graphql/2-4-7/types-c-e.md#country) #### Example @@ -1406,7 +1406,7 @@ query countries { "available_regions": [Region], "full_name_english": "abc123", "full_name_locale": "abc123", - "id": "xyz789", + "id": "abc123", "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "xyz789" } @@ -1421,13 +1421,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](types-c-e.md#country) +**Response:** [`Country`](/reference/graphql/2-4-7/types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](types-q-s.md#string) | | +| `id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -1462,10 +1462,10 @@ query country($id: String) { "country": { "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": "xyz789" + "two_letter_abbreviation": "abc123" } } } @@ -1477,7 +1477,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](types-c-e.md#currency) +**Response:** [`Currency`](/reference/graphql/2-4-7/types-c-e.md#currency) #### Example @@ -1509,12 +1509,12 @@ query currency { "available_currency_codes": [ "xyz789" ], - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", - "default_display_currecy_code": "abc123", + "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "abc123", - "default_display_currency_code": "abc123", - "default_display_currency_symbol": "abc123", + "default_display_currency_code": "xyz789", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } } @@ -1531,13 +1531,13 @@ Use `customAttributeMetadataV2` query instead. Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](/reference/graphql/2-4-7/types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](/reference/graphql/2-4-7/types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1575,13 +1575,13 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](/reference/graphql/2-4-7/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](/reference/graphql/2-4-7/types-a-b.md#attributeinput) | | #### Example @@ -1625,7 +1625,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/2-4-7/types-c-e.md#customer) #### Example @@ -1737,22 +1737,22 @@ 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": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "abc123", - "default_shipping": "xyz789", - "dob": "xyz789", + "default_shipping": "abc123", + "dob": "abc123", "email": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 987, + "group_id": 123, "id": 987, "is_subscribed": false, "job_title": "xyz789", @@ -1775,7 +1775,7 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, "telephone": "abc123", @@ -1793,7 +1793,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) #### Example @@ -1875,17 +1875,17 @@ query customerCart { "billing_address": BillingCartAddress, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "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 + "total_quantity": 123.45 } } } @@ -1897,7 +1897,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](/reference/graphql/2-4-7/types-c-e.md#customerdownloadableproducts) #### Example @@ -1933,7 +1933,7 @@ query customerDownloadableProducts { Use the `customer` query instead. -**Response:** [`CustomerOrders`](types-c-e.md#customerorders) +**Response:** [`CustomerOrders`](/reference/graphql/2-4-7/types-c-e.md#customerorders) #### Example @@ -1973,7 +1973,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](/reference/graphql/2-4-7/types-c-e.md#customerpaymenttokens) #### Example @@ -2005,15 +2005,15 @@ query customerPaymentTokens { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) +**Response:** [`DynamicBlocks!`](/reference/graphql/2-4-7/types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](/reference/graphql/2-4-7/types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -2071,13 +2071,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) +**Response:** [`HostedProUrl`](/reference/graphql/2-4-7/types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](/reference/graphql/2-4-7/types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -2115,13 +2115,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) +**Response:** [`PayflowLinkToken`](/reference/graphql/2-4-7/types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](/reference/graphql/2-4-7/types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2151,9 +2151,9 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "abc123", + "paypal_url": "xyz789", "secure_token": "abc123", - "secure_token_id": "abc123" + "secure_token_id": "xyz789" } } } @@ -2165,13 +2165,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](/reference/graphql/2-4-7/types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/2-4-7/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2223,14 +2223,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](/reference/graphql/2-4-7/types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | +| `cartId` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | PayPal order ID | #### Example @@ -2260,7 +2260,7 @@ query getPaymentOrder( ```json { "cartId": "xyz789", - "id": "xyz789" + "id": "abc123" } ``` @@ -2271,7 +2271,7 @@ query getPaymentOrder( "data": { "getPaymentOrder": { "id": "xyz789", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, "status": "abc123" } @@ -2285,13 +2285,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](/reference/graphql/2-4-7/types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/2-4-7/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2329,13 +2329,13 @@ query getPaymentSDK($location: PaymentLocation!) { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/2-4-7/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/2-4-7/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -2366,8 +2366,8 @@ query giftCardAccount($input: GiftCardAccountInput!) { "data": { "giftCardAccount": { "balance": Money, - "code": "abc123", - "expiration_date": "xyz789" + "code": "xyz789", + "expiration_date": "abc123" } } } @@ -2379,13 +2379,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) +**Response:** [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -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": "abc123", - "owner_name": "abc123", + "message": "xyz789", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, @@ -2457,13 +2457,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-7/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The registrant's email. | #### Example @@ -2485,7 +2485,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2495,12 +2495,12 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": "4", - "location": "xyz789", - "name": "abc123", - "type": "xyz789" + "location": "abc123", + "name": "xyz789", + "type": "abc123" } ] } @@ -2513,13 +2513,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-7/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -2541,7 +2541,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -2551,12 +2551,12 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "data": { "giftRegistryIdSearch": [ { - "event_date": "xyz789", - "event_title": "abc123", + "event_date": "abc123", + "event_title": "xyz789", "gift_registry_uid": 4, "location": "xyz789", "name": "abc123", - "type": "abc123" + "type": "xyz789" } ] } @@ -2569,15 +2569,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-7/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | +| `firstName` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2608,8 +2608,8 @@ query giftRegistryTypeSearch( ```json { - "firstName": "abc123", - "lastName": "xyz789", + "firstName": "xyz789", + "lastName": "abc123", "giftRegistryTypeUid": 4 } ``` @@ -2622,7 +2622,7 @@ query giftRegistryTypeSearch( "giftRegistryTypeSearch": [ { "event_date": "abc123", - "event_title": "xyz789", + "event_title": "abc123", "gift_registry_uid": 4, "location": "xyz789", "name": "abc123", @@ -2639,7 +2639,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) +**Response:** [`[GiftRegistryType]`](/reference/graphql/2-4-7/types-f-i.md#giftregistrytype) #### Example @@ -2681,13 +2681,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and postcode. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/2-4-7/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderInformationInput!`](types-k-p.md#orderinformationinput) | | +| `input` - [`OrderInformationInput!`](/reference/graphql/2-4-7/types-k-p.md#orderinformationinput) | | #### Example @@ -2770,29 +2770,29 @@ query guestOrder($input: OrderInformationInput!) { "guestOrder": { "applied_coupons": [AppliedCoupon], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], - "created_at": "abc123", + "created_at": "xyz789", "credit_memos": [CreditMemo], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": "4", - "increment_id": "xyz789", + "grand_total": 987.65, + "id": 4, + "increment_id": "abc123", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", + "number": "abc123", "order_date": "abc123", - "order_number": "xyz789", + "order_number": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", + "shipping_method": "xyz789", "status": "abc123", "token": "abc123", "total": OrderTotal @@ -2807,13 +2807,13 @@ query guestOrder($input: OrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/2-4-7/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](/reference/graphql/2-4-7/types-k-p.md#ordertokeninput) | | #### Example @@ -2898,28 +2898,28 @@ query guestOrderByToken($input: OrderTokenInput!) { "billing_address": OrderAddress, "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "abc123", + "created_at": "xyz789", "credit_memos": [CreditMemo], "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": "4", + "grand_total": 987.65, + "id": 4, "increment_id": "xyz789", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", + "number": "abc123", "order_date": "xyz789", - "order_number": "xyz789", + "order_number": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "abc123", + "shipping_method": "abc123", + "status": "xyz789", "token": "xyz789", "total": OrderTotal } @@ -2933,13 +2933,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](/reference/graphql/2-4-7/types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -2971,13 +2971,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](/reference/graphql/2-4-7/types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -2994,7 +2994,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3009,13 +3009,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](/reference/graphql/2-4-7/types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](types-q-s.md#string) | | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -3032,13 +3032,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}}} ``` @@ -3047,13 +3047,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](/reference/graphql/2-4-7/types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -3085,13 +3085,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](/reference/graphql/2-4-7/types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to check. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address to check. | #### Example @@ -3123,13 +3123,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) +**Response:** [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -3180,7 +3180,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -3196,11 +3196,11 @@ query negotiableQuote($uid: ID!) { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "email": "abc123", + "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ @@ -3208,8 +3208,8 @@ query negotiableQuote($uid: ID!) { ], "status": "SUBMITTED", "total_quantity": 987.65, - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } } } @@ -3221,13 +3221,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](types-f-i.md#id) | | +| `templateId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | | #### Example @@ -3273,7 +3273,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": 4} +{"templateId": "4"} ``` ##### Response @@ -3284,13 +3284,13 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "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": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -3299,7 +3299,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ], "status": "abc123", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -3311,16 +3311,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -3385,16 +3385,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3447,7 +3447,7 @@ query negotiableQuotes( "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -3459,18 +3459,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) +**Response:** [`PickupLocations`](/reference/graphql/2-4-7/types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](/reference/graphql/2-4-7/types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](/reference/graphql/2-4-7/types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](/reference/graphql/2-4-7/types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](/reference/graphql/2-4-7/types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3537,7 +3537,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](/reference/graphql/2-4-7/types-k-p.md#productreviewratingsmetadata) #### Example @@ -3571,17 +3571,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](types-k-p.md#products) +**Response:** [`Products`](/reference/graphql/2-4-7/types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](/reference/graphql/2-4-7/types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](/reference/graphql/2-4-7/types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -3629,7 +3629,7 @@ query products( ```json { - "search": "abc123", + "search": "xyz789", "filter": ProductAttributeFilterInput, "pageSize": 20, "currentPage": 1, @@ -3661,7 +3661,7 @@ query products( Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](/reference/graphql/2-4-7/types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3687,13 +3687,13 @@ query recaptchaV3Config { { "data": { "recaptchaV3Config": { - "badge_position": "xyz789", - "failure_message": "abc123", + "badge_position": "abc123", + "failure_message": "xyz789", "forms": ["PLACE_ORDER"], "is_enabled": true, - "language_code": "abc123", - "minimum_score": 123.45, - "website_key": "abc123" + "language_code": "xyz789", + "minimum_score": 987.65, + "website_key": "xyz789" } } } @@ -3705,13 +3705,13 @@ query recaptchaV3Config { Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) +**Response:** [`RoutableInterface`](/reference/graphql/2-4-7/types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3753,7 +3753,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](types-q-s.md#storeconfig) +**Response:** [`StoreConfig`](/reference/graphql/2-4-7/types-q-s.md#storeconfig) #### Example @@ -3995,223 +3995,223 @@ query storeConfig { "data": { "storeConfig": { "absolute_footer": "xyz789", - "allow_gift_receipt": "abc123", + "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "abc123", - "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "xyz789", - "allow_order": "xyz789", - "allow_printed_card": "abc123", + "allow_gift_wrapping_on_order_items": "xyz789", + "allow_guests_to_write_product_reviews": "abc123", + "allow_items": "abc123", + "allow_order": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", - "base_link_url": "abc123", + "base_currency_code": "abc123", + "base_link_url": "xyz789", "base_media_url": "abc123", - "base_static_url": "abc123", + "base_static_url": "xyz789", "base_url": "xyz789", - "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_allowspecific": false, "braintree_3dsecure_always_request_3ds": false, "braintree_3dsecure_specificcountry": "abc123", - "braintree_3dsecure_threshold_amount": "abc123", + "braintree_3dsecure_threshold_amount": "xyz789", "braintree_3dsecure_verify_3dsecure": false, - "braintree_ach_direct_debit_vault_active": true, + "braintree_ach_direct_debit_vault_active": false, "braintree_applepay_merchant_name": "xyz789", "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": "abc123", + "braintree_googlepay_cctypes": "xyz789", "braintree_googlepay_merchant_id": "xyz789", - "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "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": "abc123", + "braintree_local_payment_redirect_on_fail": "xyz789", "braintree_merchant_account_id": "xyz789", "braintree_paypal_button_location_cart_type_credit_color": "abc123", "braintree_paypal_button_location_cart_type_credit_label": "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_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_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": "xyz789", "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_paypal_color": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_show": true, + "braintree_paypal_button_location_cart_type_paypal_color": "abc123", + "braintree_paypal_button_location_cart_type_paypal_label": "abc123", "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_show": true, - "braintree_paypal_button_location_checkout_type_credit_color": "xyz789", + "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": "abc123", + "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789", "braintree_paypal_button_location_checkout_type_credit_show": false, "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123", "braintree_paypal_button_location_checkout_type_messaging_show": true, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", + "braintree_paypal_button_location_checkout_type_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": "xyz789", - "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": "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_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_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": "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_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_shape": "abc123", "braintree_paypal_button_location_productpage_type_paylater_show": true, - "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789", + "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": false, - "braintree_paypal_credit_uk_merchant_name": "xyz789", - "braintree_paypal_display_on_shopping_cart": false, + "braintree_paypal_button_location_productpage_type_paypal_show": true, + "braintree_paypal_credit_uk_merchant_name": "abc123", + "braintree_paypal_display_on_shopping_cart": true, "braintree_paypal_merchant_country": "xyz789", - "braintree_paypal_merchant_name_override": "xyz789", - "braintree_paypal_require_billing_address": true, + "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, "cart_gift_wrapping": "xyz789", - "cart_printed_card": "abc123", + "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": "xyz789", - "check_money_order_enable_for_specific_countries": true, - "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "xyz789", + "category_url_suffix": "abc123", + "check_money_order_enable_for_specific_countries": false, + "check_money_order_enabled": true, + "check_money_order_make_check_payable_to": "abc123", "check_money_order_max_order_total": "abc123", - "check_money_order_min_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_sort_order": 987, "check_money_order_title": "xyz789", - "cms_home_page": "xyz789", - "cms_no_cookies": "xyz789", - "cms_no_route": "xyz789", - "code": "xyz789", + "cms_home_page": "abc123", + "cms_no_cookies": "abc123", + "cms_no_route": "abc123", + "code": "abc123", "configurable_thumbnail_source": "abc123", - "contact_enabled": true, - "copyright": "abc123", - "countries_with_required_region": "abc123", - "create_account_confirmation": true, + "contact_enabled": false, + "copyright": "xyz789", + "countries_with_required_region": "xyz789", + "create_account_confirmation": false, "customer_access_token_lifetime": 123.45, "default_country": "abc123", "default_description": "abc123", - "default_display_currency_code": "xyz789", - "default_keywords": "abc123", - "default_title": "xyz789", + "default_display_currency_code": "abc123", + "default_keywords": "xyz789", + "default_title": "abc123", "demonotice": 987, - "display_state_if_optional": true, + "display_state_if_optional": false, "enable_multiple_wishlists": "abc123", "front": "abc123", - "grid_per_page": 987, + "grid_per_page": 123, "grid_per_page_values": "xyz789", - "head_includes": "xyz789", + "head_includes": "abc123", "head_shortcut_icon": "abc123", - "header_logo_src": "xyz789", + "header_logo_src": "abc123", "id": 123, - "is_default_store": true, + "is_default_store": false, "is_default_store_group": false, - "is_guest_checkout_enabled": true, + "is_guest_checkout_enabled": false, "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": true, + "is_one_page_checkout_enabled": false, "is_requisition_list_active": "xyz789", - "list_mode": "xyz789", - "list_per_page": 987, - "list_per_page_values": "abc123", - "locale": "xyz789", - "logo_alt": "xyz789", - "logo_height": 987, - "logo_width": 987, - "magento_reward_general_is_enabled": "xyz789", - "magento_reward_general_is_enabled_on_front": "xyz789", + "list_mode": "abc123", + "list_per_page": 123, + "list_per_page_values": "xyz789", + "locale": "abc123", + "logo_alt": "abc123", + "logo_height": 123, + "logo_width": 123, + "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_general_publish_history": "xyz789", + "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "xyz789", - "magento_reward_points_invitation_order_limit": "abc123", + "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "xyz789", "magento_reward_points_register": "abc123", "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "abc123", + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "xyz789", "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "xyz789", "minicart_display": true, - "minicart_max_items": 123, - "minimum_password_length": "xyz789", - "newsletter_enabled": false, - "no_route": "abc123", + "minicart_max_items": 987, + "minimum_password_length": "abc123", + "newsletter_enabled": true, + "no_route": "xyz789", "optional_zip_countries": "abc123", "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "abc123", + "printed_card_price": "xyz789", "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": "xyz789", - "returns_enabled": "abc123", + "product_url_suffix": "xyz789", + "quickorder_active": true, + "required_character_classes_number": "abc123", + "returns_enabled": "xyz789", "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": "abc123", - "sales_printed_card": "xyz789", + "sales_printed_card": "abc123", "secure_base_link_url": "abc123", - "secure_base_media_url": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 123, + "shopping_cart_display_price": 987, "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 987, - "store_code": "4", - "store_group_code": "4", + "store_code": 4, + "store_group_code": 4, "store_group_name": "abc123", "store_name": "xyz789", - "store_sort_order": 987, + "store_sort_order": 123, "timezone": "xyz789", - "title_prefix": "abc123", + "title_prefix": "xyz789", "title_separator": "xyz789", - "title_suffix": "abc123", - "use_store_in_url": false, + "title_suffix": "xyz789", + "use_store_in_url": true, "website_code": "4", "website_id": 987, - "website_name": "abc123", + "website_name": "xyz789", "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": "xyz789", + "zero_subtotal_new_order_status": "abc123", + "zero_subtotal_payment_action": "abc123", "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "xyz789" + "zero_subtotal_title": "abc123" } } } @@ -4227,13 +4227,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](types-c-e.md#entityurl) +**Response:** [`EntityUrl`](/reference/graphql/2-4-7/types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -4266,7 +4266,7 @@ query urlResolver($url: String!) { "urlResolver": { "canonical_url": "abc123", "entity_uid": "4", - "id": 123, + "id": 987, "redirectCode": 987, "relative_url": "abc123", "type": "CMS_PAGE" @@ -4285,7 +4285,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) +**Response:** [`WishlistOutput`](/reference/graphql/2-4-7/types-t-z.md#wishlistoutput) #### Example @@ -4313,7 +4313,7 @@ query wishlist { "wishlist": { "items": [WishlistItem], "items_count": 123, - "name": "xyz789", + "name": "abc123", "sharing_code": "xyz789", "updated_at": "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 index 1c419bb7c..e16e44a6e 100644 --- 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 @@ -8,7 +8,7 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -26,14 +26,14 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [BundleProductCartItemInput] } ``` @@ -48,7 +48,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -66,14 +66,14 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](/reference/graphql/2-4-7/types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [ConfigurableProductCartItemInput] } ``` @@ -88,7 +88,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -104,8 +104,8 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](/reference/graphql/2-4-7/types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example @@ -126,7 +126,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -144,10 +144,10 @@ Defines a new registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-7/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the registrant. | #### Example @@ -156,8 +156,8 @@ Defines a new registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "abc123", - "firstname": "xyz789", + "email": "xyz789", + "firstname": "abc123", "lastname": "xyz789" } ``` @@ -172,7 +172,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -190,8 +190,8 @@ Contains details about the cart after adding products to it. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]!`](/reference/graphql/2-4-7/types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -212,13 +212,13 @@ Contains products to add to an existing compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": [4], "uid": 4} +{"products": ["4"], "uid": 4} ``` @@ -231,7 +231,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -249,8 +249,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -271,15 +271,15 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { - "comment": "abc123", - "purchase_order_uid": 4 + "comment": "xyz789", + "purchase_order_uid": "4" } ``` @@ -293,7 +293,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](/reference/graphql/2-4-7/types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -311,8 +311,8 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example @@ -320,8 +320,8 @@ Defines the purchase order and cart to act on. ```json { "cart_id": "abc123", - "purchase_order_uid": 4, - "replace_existing_cart_items": false + "purchase_order_uid": "4", + "replace_existing_cart_items": true } ``` @@ -335,14 +335,14 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A description of the error. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example ```json { - "message": "xyz789", + "message": "abc123", "type": "OUT_OF_STOCK" } ``` @@ -377,7 +377,7 @@ Output of the request to add items in a requisition list to the cart. | 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`](types-c-e.md#cart) | The cart after adding requisition list items. | +| `cart` - [`Cart`](/reference/graphql/2-4-7/types-c-e.md#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 @@ -402,16 +402,13 @@ Defines a return comment. | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `comment_text` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example ```json -{ - "comment_text": "xyz789", - "return_uid": "4" -} +{"comment_text": "xyz789", "return_uid": 4} ``` @@ -424,7 +421,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | The modified return. | +| `return` - [`Return`](/reference/graphql/2-4-7/types-q-s.md#return) | The modified return. | #### Example @@ -442,9 +439,9 @@ Defines tracking information to be added to the return. | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | +| `carrier_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The shipping tracking number for this return request. | #### Example @@ -452,7 +449,7 @@ Defines tracking information to be added to the return. { "carrier_uid": 4, "return_uid": 4, - "tracking_number": "xyz789" + "tracking_number": "abc123" } ``` @@ -466,8 +463,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](/reference/graphql/2-4-7/types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](/reference/graphql/2-4-7/types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -488,8 +485,8 @@ Defines the simple and group products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](/reference/graphql/2-4-7/types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example @@ -510,7 +507,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -528,8 +525,8 @@ Defines the virtual products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](/reference/graphql/2-4-7/types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example @@ -550,7 +547,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -568,9 +565,9 @@ Contains the resultant wish list and any error information. | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](/reference/graphql/2-4-7/types-t-z.md#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!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -594,19 +591,19 @@ Contains information for each filterable option (such as price, category `UID`, | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | -| `label` - [`String`](types-q-s.md#string) | The aggregation display name. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The aggregation display name. | | `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "count": 123, - "label": "xyz789", + "label": "abc123", "options": [AggregationOption], "position": 123 } @@ -622,17 +619,17 @@ An implementation of `AggregationOptionInterface`. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example ```json { - "count": 123, + "count": 987, "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -646,9 +643,9 @@ Defines aggregation option fields. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -662,7 +659,7 @@ Defines aggregation option fields. { "count": 987, "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -681,7 +678,7 @@ Filter category aggregations in layered navigation. #### Example ```json -{"includeDirectChildrenOnly": true} +{"includeDirectChildrenOnly": false} ``` @@ -711,13 +708,13 @@ An input object that specifies the filters used in product aggregations. | Field Name | Description | |------------|-------------| | `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `payment_intent` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-7/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -725,12 +722,12 @@ An input object that specifies the filters used in product aggregations. { "button_styles": ButtonStyles, "code": "abc123", - "is_visible": false, + "is_visible": true, "payment_intent": "xyz789", - "payment_source": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "xyz789" + "sort_order": "abc123", + "title": "abc123" } ``` @@ -744,16 +741,16 @@ Apple Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | PayPal order ID | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "abc123", + "payment_source": "xyz789", + "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } ``` @@ -768,12 +765,12 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example ```json -{"code": "xyz789"} +{"code": "abc123"} ``` @@ -786,19 +783,19 @@ Contains an applied gift card with applied and remaining balance. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `applied_balance` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "applied_balance": Money, - "code": "xyz789", + "code": "abc123", "current_balance": Money, - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -812,8 +809,8 @@ Contains the applied and current balances. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](types-k-p.md#money) | The current balance remaining on store credit. | +| `applied_balance` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#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 @@ -822,7 +819,7 @@ Contains the applied and current balances. { "applied_balance": Money, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -836,15 +833,15 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A valid coupon code. | #### Example ```json { - "cart_id": "xyz789", - "coupon_code": "xyz789" + "cart_id": "abc123", + "coupon_code": "abc123" } ``` @@ -858,7 +855,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -895,8 +892,8 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](types-q-s.md#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -919,8 +916,8 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example @@ -941,7 +938,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -959,7 +956,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -977,7 +974,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -995,7 +992,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -1013,13 +1010,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | Input Field | Description | |-------------|-------------| -| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | -| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| `radius` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 123, "search_term": "xyz789"} +{"radius": 123, "search_term": "abc123"} ``` @@ -1032,7 +1029,7 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](/reference/graphql/2-4-7/types-c-e.md#comparelist) | The contents of the customer's compare list. | | `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | #### Example @@ -1051,22 +1048,22 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The data type of the attribute. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `attribute_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](/reference/graphql/2-4-7/types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "attribute_options": [AttributeOption], - "attribute_type": "xyz789", - "entity_type": "xyz789", - "input_type": "xyz789", + "attribute_type": "abc123", + "entity_type": "abc123", + "input_type": "abc123", "storefront_properties": StorefrontProperties } ``` @@ -1120,18 +1117,18 @@ An input object that specifies the filters used for attributes. ```json { - "is_comparable": true, + "is_comparable": false, "is_filterable": true, - "is_filterable_in_search": true, - "is_html_allowed_on_front": true, - "is_searchable": 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": false, - "is_used_for_promo_rules": true, - "is_visible_in_advanced_search": true, - "is_visible_on_front": false, - "is_wysiwyg_enabled": true, - "used_in_product_listing": false + "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": true } ``` @@ -1178,15 +1175,15 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `attribute_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of entity that defines the attribute. | #### Example ```json { "attribute_code": "xyz789", - "entity_type": "abc123" + "entity_type": "xyz789" } ``` @@ -1200,7 +1197,7 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute option value. | #### Example @@ -1218,28 +1215,28 @@ Base EAV implementation of CustomAttributeMetadataInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Default attribute value. | | `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/2-4-7/types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example ```json { - "code": "4", - "default_value": "abc123", + "code": 4, + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_required": true, "is_unique": true, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -1254,14 +1251,14 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "type": "ENTITY_NOT_FOUND" } ``` @@ -1297,15 +1294,15 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute option value. | #### Example ```json { - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -1320,15 +1317,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| | `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute option value. | #### Example ```json { "is_default": false, - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -1341,8 +1338,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute selected option value. | #### Example @@ -1361,8 +1358,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1374,7 +1371,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "label": "xyz789", + "label": "abc123", "value": "abc123" } ``` @@ -1387,14 +1384,14 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example ```json { - "code": 4, + "code": "4", "selected_options": [AttributeSelectedOptionInterface] } ``` @@ -1407,13 +1404,16 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The attribute value. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute value. | #### Example ```json -{"code": 4, "value": "abc123"} +{ + "code": "4", + "value": "xyz789" +} ``` @@ -1426,15 +1426,15 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The code of the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The code of the attribute. | | `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "selected_options": [AttributeInputSelectedOption], "value": "xyz789" } @@ -1448,7 +1448,7 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1460,7 +1460,7 @@ Specifies the value for attribute. #### Example ```json -{"code": 4} +{"code": "4"} ``` @@ -1474,7 +1474,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/2-4-7/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1496,7 +1496,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/2-4-7/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1517,8 +1517,8 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](/reference/graphql/2-4-7/types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Currency symbol, for example $. | #### Example @@ -1536,17 +1536,17 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](types-q-s.md#string) | The payment method title. | +| `title` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method title. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "is_deferred": false, - "title": "abc123" + "title": "xyz789" } ``` @@ -1560,16 +1560,16 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#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`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | -| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | -| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `base_amount` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1578,10 +1578,10 @@ Contains details about the possible shipping methods and carriers. "amount": Money, "available": true, "base_amount": Money, - "carrier_code": "abc123", + "carrier_code": "xyz789", "carrier_title": "abc123", - "error_message": "xyz789", - "method_code": "xyz789", + "error_message": "abc123", + "method_code": "abc123", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -1616,8 +1616,8 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `address` - [`CartAddressInput`](/reference/graphql/2-4-7/types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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. | @@ -1627,8 +1627,8 @@ Defines the billing address. { "address": CartAddressInput, "customer_address_id": 123, - "same_as_shipping": false, - "use_for_shipping": true + "same_as_shipping": true, + "use_for_shipping": false } ``` @@ -1642,23 +1642,23 @@ Contains details about the billing address. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/2-4-7/types-c-e.md#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`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `customer_notes` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](/reference/graphql/2-4-7/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example @@ -1670,17 +1670,17 @@ Contains details about the billing address. "custom_attributes": [AttributeValueInterface], "customer_notes": "abc123", "fax": "xyz789", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "xyz789", "middlename": "abc123", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": CartAddressRegion, - "street": ["abc123"], - "suffix": "xyz789", + "street": ["xyz789"], + "suffix": "abc123", "telephone": "xyz789", "uid": "abc123", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -1704,14 +1704,14 @@ true | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | | -| `public_hash` - [`String!`](types-q-s.md#string) | | +| `device_data` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `public_hash` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example ```json { - "device_data": "xyz789", + "device_data": "abc123", "public_hash": "abc123" } ``` @@ -1724,9 +1724,9 @@ true | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway. | +| `device_data` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-q-s.md#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | +| `payment_method_nonce` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | #### Example @@ -1746,15 +1746,15 @@ true | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | | -| `public_hash` - [`String!`](types-q-s.md#string) | | +| `device_data` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `public_hash` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example ```json { "device_data": "abc123", - "public_hash": "abc123" + "public_hash": "xyz789" } ``` @@ -1768,21 +1768,21 @@ Contains details about an individual category that comprises a breadcrumb. | Field Name | Description | |------------|-------------| -| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](types-f-i.md#int) | The category level. | -| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | -| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | +| `category_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The category level. | +| `category_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL path of the category. | #### Example ```json { "category_id": 123, - "category_level": 987, - "category_name": "abc123", - "category_uid": 4, + "category_level": 123, + "category_name": "xyz789", + "category_uid": "4", "category_url_key": "xyz789", "category_url_path": "abc123" } @@ -1798,23 +1798,23 @@ An implementation for bundle product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-7/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | | `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-7/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1829,14 +1829,14 @@ An implementation for bundle product cart items. "gift_wrapping": GiftWrapping, "id": "abc123", "is_available": false, - "max_qty": 123.45, - "min_qty": 987.65, + "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" + "quantity": 123.45, + "uid": 4 } ``` @@ -1850,14 +1850,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-7/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | #### Example @@ -1865,11 +1865,11 @@ Defines bundle product options for `CreditMemoItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 123.45 } ``` @@ -1884,14 +1884,14 @@ Defines bundle product options for `InvoiceItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-7/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1899,12 +1899,12 @@ Defines bundle product options for `InvoiceItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -1918,15 +1918,15 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | | `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | -| `title` - [`String`](types-q-s.md#string) | The display name of the item. | -| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example @@ -1936,11 +1936,11 @@ Defines an individual item within a bundle product. "options": [BundleItemOption], "position": 123, "price_range": PriceRange, - "required": true, + "required": false, "sku": "xyz789", - "title": "abc123", + "title": "xyz789", "type": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -1955,32 +1955,32 @@ Defines the characteristics that comprise a specific bundle item and its options | Field Name | Description | |------------|-------------| | `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](types-f-i.md#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-q-s.md#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": true, - "id": 987, + "can_change_quantity": false, + "id": 123, "is_default": false, "label": "abc123", "position": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "product": ProductInterface, "qty": 123.45, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -1994,17 +1994,17 @@ Defines the input for a bundle option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array with the chosen value of the option. | #### Example ```json { - "id": 123, + "id": 987, "quantity": 123.45, - "value": ["abc123"] + "value": ["xyz789"] } ``` @@ -2018,27 +2018,27 @@ Defines bundle product options for `OrderItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-7/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#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]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-7/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-7/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the order item. | #### Example @@ -2046,25 +2046,25 @@ Defines bundle product options for `OrderItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, "quantity_ordered": 987.65, "quantity_refunded": 987.65, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -2078,105 +2078,105 @@ Defines basic features of a bundle product and contains multiple BundleItems. | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](/reference/graphql/2-4-7/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-7/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#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`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `gift_message_available` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether the product can be returned. | | `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-7/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-7/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](/reference/graphql/2-4-7/types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-7/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](/reference/graphql/2-4-7/types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-7/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | The list of products reviews. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](/reference/graphql/2-4-7/types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-7/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-7/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-7/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "attribute_set_id": 123, - "canonical_url": "abc123", + "attribute_set_id": 987, + "canonical_url": "xyz789", "categories": [CategoryInterface], "color": 123, "country_of_manufacture": "xyz789", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "dynamic_price": true, - "dynamic_sku": true, - "dynamic_weight": true, + "dynamic_sku": false, + "dynamic_weight": false, "gift_message_available": "abc123", - "id": 123, + "id": 987, "image": ProductImage, "is_returnable": "abc123", "items": [BundleItem], - "manufacturer": 987, + "manufacturer": 123, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "abc123", - "new_from_date": "abc123", + "new_from_date": "xyz789", "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price": ProductPrices, "price_details": PriceDetails, "price_range": PriceRange, @@ -2184,31 +2184,31 @@ Defines basic features of a bundle product and contains multiple BundleItems. "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], "rating_summary": 123.45, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, + "relative_url": "xyz789", + "review_count": 987, "reviews": ProductReviews, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "abc123", + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", + "type_id": "xyz789", "uid": "4", "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website], @@ -2227,8 +2227,8 @@ Defines a single bundle product. | 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]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-7/types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-7/types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -2250,11 +2250,11 @@ Contains details about bundle products added to a requisition list. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2264,7 +2264,7 @@ Contains details about bundle products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -2278,25 +2278,25 @@ Defines bundle product options for `ShipmentItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-7/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of shipped items. | #### Example ```json { "bundle_options": [ItemSelectedBundleOption], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "product_sku": "abc123", + "quantity_shipped": 123.45 } ``` @@ -2310,13 +2310,13 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](/reference/graphql/2-4-7/types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -2326,9 +2326,9 @@ Defines bundle product options for `WishlistItemInterface`. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -2340,11 +2340,11 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | -| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | -| `label` - [`String`](types-q-s.md#string) | The button label | -| `layout` - [`String`](types-q-s.md#string) | The button layout | -| `shape` - [`String`](types-q-s.md#string) | The button shape | +| `color` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The button color | +| `height` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The button label | +| `layout` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The button layout | +| `shape` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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 | @@ -2352,12 +2352,12 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "abc123", - "height": 987, + "color": "xyz789", + "height": 123, "label": "abc123", - "layout": "abc123", + "layout": "xyz789", "shape": "xyz789", - "tagline": true, + "tagline": false, "use_default_height": true } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md index b611d5de6..9034f959a 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md @@ -8,15 +8,15 @@ Specifies the quote template id of the quote template to cancel | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `cancellation_comment` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "cancellation_comment": "abc123", - "template_id": "4" + "template_id": 4 } ``` @@ -30,13 +30,16 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](types-f-i.md#id) | Order ID. | -| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | +| `order_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | Order ID. | +| `reason` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Cancellation reason. | #### Example ```json -{"order_id": 4, "reason": "abc123"} +{ + "order_id": "4", + "reason": "xyz789" +} ``` @@ -49,14 +52,14 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | +| `error` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Error encountered while cancelling the order. | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | #### Example ```json { - "error": "xyz789", + "error": "abc123", "order": CustomerOrder } ``` @@ -69,7 +72,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](types-q-s.md#string) | | +| `description` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example @@ -86,10 +89,10 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| | `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `name` - [`String`](types-q-s.md#string) | Name on the card | +| `card_expiry_month` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Name on the card | #### Example @@ -98,7 +101,7 @@ Contains the updated customer order and error message if any. "bin_details": CardBin, "card_expiry_month": "abc123", "card_expiry_year": "xyz789", - "last_digits": "xyz789", + "last_digits": "abc123", "name": "xyz789" } ``` @@ -111,12 +114,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](types-q-s.md#string) | Card bin number | +| `bin` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "xyz789"} +{"bin": "abc123"} ``` @@ -129,27 +132,27 @@ Contains the contents and other details about a guest or customer cart. | Field Name | Description | |------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart contains only virtual products. | +| `applied_coupon` - [`AppliedCoupon`](/reference/graphql/2-4-7/types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](/reference/graphql/2-4-7/types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](/reference/graphql/2-4-7/types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](/reference/graphql/2-4-7/types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](/reference/graphql/2-4-7/types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/2-4-7/types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](/reference/graphql/2-4-7/types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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!`](types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | -| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/2-4-7/types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](/reference/graphql/2-4-7/types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -167,15 +170,15 @@ Contains the contents and other details about a guest or customer cart. "gift_message": GiftMessage, "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": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } ``` @@ -189,14 +192,14 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The country code. | -| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The country code. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display label for the country. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "abc123" } ``` @@ -211,44 +214,44 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "abc123", "custom_attributes": [AttributeValueInput], "fax": "xyz789", "firstname": "xyz789", - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "postcode": "abc123", "prefix": "xyz789", - "region": "abc123", - "region_id": 987, + "region": "xyz789", + "region_id": 123, "save_in_address_book": false, "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", + "suffix": "xyz789", + "telephone": "xyz789", "vat_id": "xyz789" } ``` @@ -261,50 +264,50 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company specified for the billing or shipping address. | | `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | | `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | -| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | +| [`ShippingCartAddress`](/reference/graphql/2-4-7/types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](/reference/graphql/2-4-7/types-a-b.md#billingcartaddress) | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", "prefix": "abc123", "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "xyz789", - "uid": "abc123", - "vat_id": "abc123" + "uid": "xyz789", + "vat_id": "xyz789" } ``` @@ -318,17 +321,17 @@ Contains details about the region in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The state or province code. | -| `label` - [`String`](types-q-s.md#string) | The display label for the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The state or province code. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "code": "xyz789", - "label": "xyz789", - "region_id": 987 + "label": "abc123", + "region_id": 123 } ``` @@ -342,8 +345,8 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the discount. | #### Example @@ -380,7 +383,7 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message | #### Example @@ -417,19 +420,19 @@ Defines an item to be added to the cart. | Input Field | Description | |-------------|-------------| | `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | +| `parent_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-7/types-f-i.md#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!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the product. | #### Example ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": [4], + "parent_sku": "abc123", + "quantity": 987.65, + "selected_options": ["4"], "sku": "xyz789" } ``` @@ -446,27 +449,27 @@ An interface for products in a cart. |------------|-------------| | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](types-q-s.md#simplecartitem) | -| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | +| [`SimpleCartItem`](/reference/graphql/2-4-7/types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](/reference/graphql/2-4-7/types-t-z.md#virtualcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](types-a-b.md#bundlecartitem) | -| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | +| [`BundleCartItem`](/reference/graphql/2-4-7/types-a-b.md#bundlecartitem) | +| [`GiftCardCartItem`](/reference/graphql/2-4-7/types-f-i.md#giftcardcartitem) | #### Example @@ -477,7 +480,7 @@ An interface for products in a cart. "id": "abc123", "is_available": true, "max_qty": 123.45, - "min_qty": 123.45, + "min_qty": 987.65, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -498,12 +501,12 @@ Contains details about the price of the item, including taxes and discounts. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | -| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/2-4-7/types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#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!`](/reference/graphql/2-4-7/types-k-p.md#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!`](/reference/graphql/2-4-7/types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -529,13 +532,13 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `cart_item_id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart_item_id": 987, "quantity": 123.45} +{"cart_item_id": 123, "quantity": 123.45} ``` @@ -548,9 +551,9 @@ Contains details about the price of a selected customizable value. | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](types-f-i.md#float) | A price value. | +| `type` - [`PriceTypeEnum!`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | A price value. | #### Example @@ -572,23 +575,23 @@ A single item to be updated. | Input Field | Description | |-------------|-------------| -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | | `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/2-4-7/types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The new quantity of the item. | #### Example ```json { - "cart_item_id": 987, - "cart_item_uid": "4", + "cart_item_id": 123, + "cart_item_uid": 4, "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": 4, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -601,8 +604,8 @@ A single item to be updated. | Field Name | Description | |------------|-------------| | `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of returned cart items. | #### Example @@ -627,11 +630,11 @@ Contains details about the final price of items in the cart, including discount | `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`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | -| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/2-4-7/types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `subtotal_excluding_tax` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -658,15 +661,15 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the tax. | #### Example ```json { "amount": Money, - "label": "abc123" + "label": "xyz789" } ``` @@ -681,14 +684,14 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -745,58 +748,58 @@ Swatch attribute metadata. | Field Name | Description | |------------|-------------| | `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-7/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-7/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](/reference/graphql/2-4-7/types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example ```json { "apply_to": ["SIMPLE"], - "code": 4, + "code": "4", "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_comparable": false, + "is_comparable": true, "is_filterable": true, - "is_filterable_in_search": false, + "is_filterable_in_search": true, "is_html_allowed_on_front": true, - "is_required": false, + "is_required": true, "is_searchable": false, "is_unique": true, - "is_used_for_price_rules": false, + "is_used_for_price_rules": true, "is_used_for_promo_rules": true, - "is_visible_in_advanced_search": 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": true + "update_product_preview_image": false, + "use_product_image_for_swatch": false, + "used_in_product_listing": false } ``` @@ -810,13 +813,13 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -842,39 +845,39 @@ Contains the full set of attributes that can be returned in a category search. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | +| `automatic_sorting` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/2-4-7/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](/reference/graphql/2-4-7/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -886,27 +889,27 @@ Contains the full set of attributes that can be returned in a category search. ```json { - "automatic_sorting": "xyz789", + "automatic_sorting": "abc123", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children_count": "abc123", "cms_block": CmsBlock, - "created_at": "xyz789", + "created_at": "abc123", "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", - "description": "abc123", - "display_mode": "xyz789", + "description": "xyz789", + "display_mode": "abc123", "filter_price_range": 123.45, - "id": 987, - "image": "abc123", + "id": 123, + "image": "xyz789", "include_in_menu": 123, - "is_anchor": 987, + "is_anchor": 123, "landing_page": 987, "level": 987, - "meta_description": "abc123", - "meta_keywords": "xyz789", - "meta_title": "xyz789", + "meta_description": "xyz789", + "meta_keywords": "abc123", + "meta_title": "abc123", "name": "xyz789", "path": "abc123", "path_in_store": "xyz789", @@ -914,11 +917,11 @@ Contains the full set of attributes that can be returned in a category search. "product_count": 987, "products": CategoryProducts, "staged": true, - "uid": 4, + "uid": "4", "updated_at": "xyz789", "url_key": "xyz789", - "url_path": "xyz789", - "url_suffix": "abc123" + "url_path": "abc123", + "url_suffix": "xyz789" } ``` @@ -932,9 +935,9 @@ Contains details about the products assigned to a category. | Field Name | Description | |------------|-------------| -| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `items` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -942,7 +945,7 @@ Contains details about the products assigned to a category. { "items": [ProductInterface], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -957,8 +960,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | Field Name | Description | |------------|-------------| | `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -980,85 +983,85 @@ Contains the hierarchy of categories. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled. | +| `automatic_sorting` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/2-4-7/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | | +| `children_count` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "automatic_sorting": "abc123", - "available_sort_by": ["xyz789"], + "automatic_sorting": "xyz789", + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children": [CategoryTree], "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "xyz789", "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", + "default_sort_by": "abc123", "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 987.65, - "id": 123, + "id": 987, "image": "abc123", "include_in_menu": 123, "is_anchor": 123, - "landing_page": 987, + "landing_page": 123, "level": 123, "meta_description": "xyz789", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "xyz789", - "name": "abc123", + "name": "xyz789", "path": "xyz789", "path_in_store": "xyz789", "position": 123, - "product_count": 987, + "product_count": 123, "products": CategoryProducts, - "redirect_code": 123, + "redirect_code": 987, "relative_url": "abc123", - "staged": false, + "staged": true, "type": "CMS_PAGE", "uid": 4, - "updated_at": "abc123", - "url_key": "abc123", + "updated_at": "xyz789", + "url_key": "xyz789", "url_path": "abc123", - "url_suffix": "xyz789" + "url_suffix": "abc123" } ``` @@ -1072,23 +1075,23 @@ Defines details about an individual checkout agreement. | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | -| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | +| `agreement_id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | | `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name given to the condition. | #### Example ```json { - "agreement_id": 123, - "checkbox_text": "xyz789", - "content": "xyz789", + "agreement_id": 987, + "checkbox_text": "abc123", + "content": "abc123", "content_height": "abc123", - "is_html": false, + "is_html": true, "mode": "AUTO", "name": "xyz789" } @@ -1124,16 +1127,16 @@ An error encountered while adding an item to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `path` - [`[String]!`](types-q-s.md#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 | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#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": "xyz789", - "path": ["abc123"] + "message": "abc123", + "path": ["xyz789"] } ``` @@ -1167,13 +1170,13 @@ Contains details about errors encountered when a customer clear cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message | | `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -1205,12 +1208,12 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Cart` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `Cart` object. | #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -1246,7 +1249,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -1262,9 +1265,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-7/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-7/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-7/types-f-i.md#internalerror) | #### Example @@ -1283,7 +1286,7 @@ Contains details about a failed close operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1302,7 +1305,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/2-4-7/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1321,7 +1324,7 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example @@ -1339,10 +1342,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `closed_quotes` - [`[NegotiableQuote]`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/2-4-7/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/2-4-7/types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1367,15 +1370,15 @@ Contains details about a specific CMS block. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | -| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | +| `content` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The title assigned to the CMS block. | #### Example ```json { - "content": "xyz789", + "content": "abc123", "identifier": "abc123", "title": "abc123" } @@ -1409,26 +1412,26 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | +| `content` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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", + "content": "abc123", + "content_heading": "abc123", + "identifier": "xyz789", "meta_description": "xyz789", "meta_keywords": "abc123", "meta_title": "xyz789", @@ -1449,12 +1452,12 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1486,7 +1489,7 @@ Specifies which field to sort on, and whether to return the results in ascending | Input Field | Description | |-------------|-------------| | `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | +| `order` - [`SortEnum!`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1508,13 +1511,13 @@ Contains the output schema for a 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`](types-q-s.md#string) | The email address of the company contact. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | -| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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. | @@ -1522,7 +1525,7 @@ Contains the output schema for a company. | `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`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1535,9 +1538,9 @@ Contains the output schema for a company. "email": "abc123", "id": 4, "legal_address": CompanyLegalAddress, - "legal_name": "abc123", - "name": "abc123", - "payment_methods": ["abc123"], + "legal_name": "xyz789", + "name": "xyz789", + "payment_methods": ["xyz789"], "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, @@ -1561,9 +1564,9 @@ Contains details about the access control list settings of a resource. | Field Name | Description | |------------|-------------| | `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | -| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the ACL resource. | #### Example @@ -1571,8 +1574,8 @@ Contains details about the access control list settings of a resource. { "children": [CompanyAclResource], "id": 4, - "sort_order": 987, - "text": "abc123" + "sort_order": 123, + "text": "xyz789" } ``` @@ -1586,20 +1589,20 @@ Defines the input schema for creating a company administrator. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | -| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | -| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company administrator's last name. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "gender": 987, - "job_title": "xyz789", + "job_title": "abc123", "lastname": "xyz789" } ``` @@ -1614,16 +1617,16 @@ The minimal required information to identify and display the company. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the company. | #### Example ```json { "id": 4, - "legal_name": "abc123", + "legal_name": "xyz789", "name": "abc123" } ``` @@ -1639,12 +1642,12 @@ Defines the input schema for creating a new company. | Input Field | Description | |-------------|-------------| | `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String!`](types-q-s.md#string) | The name of the company to create. | +| `company_email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the company to create. | | `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1652,9 +1655,9 @@ Defines the input schema for creating a new company. { "company_admin": CompanyAdminInput, "company_email": "abc123", - "company_name": "abc123", + "company_name": "xyz789", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "xyz789", "vat_tax_id": "xyz789" } @@ -1670,9 +1673,9 @@ Contains company credit balances and limits. | Field Name | Description | |------------|-------------| -| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](types-k-p.md#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. | +| `available_credit` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#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!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#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 @@ -1695,8 +1698,8 @@ Contains details about prior company credit operations. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1718,9 +1721,9 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The name of the person submitting the company credit operation. | +| `updated_by` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example @@ -1742,10 +1745,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the company credit operation. | +| `amount` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of the company credit operation. | | `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](types-q-s.md#string) | The date the operation occurred. | +| `custom_reference_number` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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. | @@ -1793,7 +1796,7 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -1829,16 +1832,16 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The invitation code. | -| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "code": "abc123", - "role_id": "4", + "code": "xyz789", + "role_id": 4, "user": CompanyInvitationUserInput } ``` @@ -1853,12 +1856,12 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -1871,11 +1874,11 @@ Company user attributes in the invitation. | Input Field | Description | |-------------|-------------| -| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | -| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `company_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The job title of a company user. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The phone number of the company user. | #### Example @@ -1883,7 +1886,7 @@ Company user attributes in the invitation. { "company_id": 4, "customer_id": "4", - "job_title": "abc123", + "job_title": "xyz789", "status": "ACTIVE", "telephone": "xyz789" } @@ -1899,23 +1902,23 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The company's postal code. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company's postal code. | | `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | +| `street` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company's phone number. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "country_code": "AF", "postcode": "abc123", "region": CustomerAddressRegion, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -1929,12 +1932,12 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -1944,7 +1947,7 @@ Defines the input schema for defining a company's legal address. "country_id": "AF", "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "xyz789" } ``` @@ -1959,12 +1962,12 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The city where the company is registered to conduct business. | | `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -1972,10 +1975,10 @@ Defines the input schema for updating a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["xyz789"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1989,19 +1992,19 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the role. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name assigned to the role. | | `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | +| `users_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { - "id": "4", - "name": "abc123", + "id": 4, + "name": "xyz789", "permissions": [CompanyAclResource], - "users_count": 987 + "users_count": 123 } ``` @@ -2015,15 +2018,15 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | -| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "name": "xyz789", - "permissions": ["xyz789"] + "name": "abc123", + "permissions": ["abc123"] } ``` @@ -2037,16 +2040,16 @@ Defines the input schema for updating a company role. | Input Field | Description | |-------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | -| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { "id": 4, - "name": "xyz789", + "name": "abc123", "permissions": ["abc123"] } ``` @@ -2062,8 +2065,8 @@ Contains an array of roles. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2071,7 +2074,7 @@ Contains an array of roles. { "items": [CompanyRole], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2085,15 +2088,15 @@ Contains details about a company sales representative. | Field Name | Description | |------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | -| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | -| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", "lastname": "abc123" } @@ -2145,8 +2148,8 @@ Defines an individual node in the company structure. | Field Name | Description | |------------|-------------| | `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example @@ -2168,13 +2171,13 @@ Defines the input schema for updating the company structure. | Input Field | Description | |-------------|-------------| -| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | +| `parent_tree_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": 4, "tree_id": "4"} +{"parent_tree_id": "4", "tree_id": 4} ``` @@ -2187,19 +2190,19 @@ Describes a company team. | Field Name | Description | |------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | -| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | ID of the company structure | #### Example ```json { - "description": "xyz789", - "id": "4", - "name": "xyz789", - "structure_id": 4 + "description": "abc123", + "id": 4, + "name": "abc123", + "structure_id": "4" } ``` @@ -2213,17 +2216,17 @@ Defines the input schema for creating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "description": "abc123", - "name": "xyz789", - "target_id": 4 + "description": "xyz789", + "name": "abc123", + "target_id": "4" } ``` @@ -2237,9 +2240,9 @@ Defines the input schema for updating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the team. | #### Example @@ -2261,12 +2264,12 @@ Defines the input schema for updating a company. | Input Field | Description | |-------------|-------------| -| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String`](types-q-s.md#string) | The name of the company to update. | +| `company_email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the company to update. | | `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -2275,7 +2278,7 @@ Defines the input schema for updating a company. "company_email": "xyz789", "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "xyz789", "vat_tax_id": "xyz789" } @@ -2291,23 +2294,23 @@ Defines the input schema for creating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The company user's email address | -| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | -| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | -| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | +| `target_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", "job_title": "abc123", - "lastname": "abc123", + "lastname": "xyz789", "role_id": 4, "status": "ACTIVE", "target_id": 4, @@ -2344,27 +2347,27 @@ Defines the input schema for updating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The company user's email address. | -| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company user's phone number. | #### Example ```json { "email": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "id": "4", "job_title": "abc123", "lastname": "abc123", "role_id": 4, "status": "ACTIVE", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -2379,8 +2382,8 @@ Contains details about company users. | Field Name | Description | |------------|-------------| | `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of objects returned. | #### Example @@ -2420,14 +2423,14 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The label of the attribute code. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "label": "abc123" } ``` @@ -2442,9 +2445,9 @@ Defines an object used to iterate through items for product comparisons. | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | +| `attributes` - [`[ProductAttribute]!`](/reference/graphql/2-4-7/types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2452,7 +2455,7 @@ Defines an object used to iterate through items for product comparisons. { "attributes": [ProductAttribute], "product": ProductInterface, - "uid": 4 + "uid": "4" } ``` @@ -2467,16 +2470,16 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| | `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](types-f-i.md#int) | The number of items in the compare list. | +| `item_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of items in the compare list. | | `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": 4 } @@ -2490,7 +2493,7 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| -| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | +| `html` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Text that can contain HTML tags. | #### Example @@ -2508,19 +2511,19 @@ Contains details about a configurable product attribute option. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | -| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "code": "abc123", - "label": "xyz789", - "uid": "4", - "value_index": 987 + "code": "xyz789", + "label": "abc123", + "uid": 4, + "value_index": 123 } ``` @@ -2534,24 +2537,24 @@ An implementation for configurable product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#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`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2566,15 +2569,15 @@ An implementation for configurable product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "abc123", - "is_available": true, - "max_qty": 987.65, - "min_qty": 123.45, + "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" + "uid": 4 } ``` @@ -2588,15 +2591,15 @@ Describes configurable options that have been selected and can be selected as a | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { "attribute_code": "xyz789", - "option_value_uids": [4] + "option_value_uids": ["4"] } ``` @@ -2610,97 +2613,97 @@ Defines basic features of a configurable product and its simple product variants | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-7/types-k-p.md#productcustomattributes) | Product custom attributes. | | `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `gift_message_available` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `options_container` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-7/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-7/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-7/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-7/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-7/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/2-4-7/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { "attribute_set_id": 987, - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "color": 123, + "color": 987, "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "abc123", - "created_at": "xyz789", + "country_of_manufacture": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": "abc123", - "id": 123, + "gift_message_available": "xyz789", + "id": 987, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "manufacturer": 987, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "name": "xyz789", - "new_from_date": "xyz789", + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "name": "abc123", + "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", "price": ProductPrices, @@ -2711,32 +2714,32 @@ Defines basic features of a configurable product and its simple product variants "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_from_date": "abc123", - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "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_key": "abc123", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "variants": [ConfigurableVariant], "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -2750,8 +2753,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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`](types-q-s.md#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](types-q-s.md#string) | Deprecated. Use `CartItemInput.sku` instead. | +| `parent_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Deprecated. Use `CartItemInput.sku` instead. | #### Example @@ -2759,7 +2762,7 @@ Defines basic features of a configurable product and its simple product variants { "customizable_options": [CustomizableOptionInput], "data": CartItemInput, - "parent_sku": "xyz789", + "parent_sku": "abc123", "variant_sku": "xyz789" } ``` @@ -2774,9 +2777,9 @@ Contains details about configurable product options. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the configurable option. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the configurable option. | | `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example @@ -2800,21 +2803,21 @@ Defines a value for a configurable product option. | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](/reference/graphql/2-4-7/types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the value. | #### Example ```json { - "is_available": false, + "is_available": true, "is_use_default": true, - "label": "abc123", + "label": "xyz789", "swatch": SwatchDataInterface, - "uid": "4" + "uid": 4 } ``` @@ -2828,30 +2831,30 @@ Defines configurable attributes for the specified product. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is the default. | +| `attribute_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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": "abc123", + "attribute_code": "xyz789", "attribute_id": "xyz789", - "attribute_id_v2": 123, - "attribute_uid": 4, - "id": 123, - "label": "xyz789", + "attribute_id_v2": 987, + "attribute_uid": "4", + "id": 987, + "label": "abc123", "position": 123, - "product_id": 987, + "product_id": 123, "uid": 4, "use_default": true, "values": [ConfigurableProductOptionsValues] @@ -2869,9 +2872,9 @@ Contains metadata corresponding to the selected configurable options. | Field Name | Description | |------------|-------------| | `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#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`](types-q-s.md#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. | +| `variant` - [`SimpleProduct`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -2896,13 +2899,13 @@ Contains the index number assigned to a configurable product option. | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | -| `label` - [`String`](types-q-s.md#string) | The label of the product. | -| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | +| `default_label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](/reference/graphql/2-4-7/types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example @@ -2914,7 +2917,7 @@ Contains the index number assigned to a configurable product option. "swatch_data": SwatchDataInterface, "uid": "4", "use_default_value": false, - "value_index": 123 + "value_index": 987 } ``` @@ -2928,11 +2931,11 @@ Contains details about configurable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](/reference/graphql/2-4-7/types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2942,7 +2945,7 @@ Contains details about configurable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -2957,7 +2960,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](/reference/graphql/2-4-7/types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -2978,15 +2981,15 @@ A configurable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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]`](/reference/graphql/2-4-7/types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -2997,7 +3000,7 @@ A configurable product wish list item. "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": "4", "product": ProductInterface, "quantity": 987.65 @@ -3014,8 +3017,8 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | -| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address to be confirmed. | #### Example @@ -3053,19 +3056,19 @@ List of account confirmation statuses. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | -| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | -| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | +| `comment` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The shopper's telephone number. | #### Example ```json { "comment": "xyz789", - "email": "xyz789", + "email": "abc123", "name": "xyz789", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -3079,7 +3082,7 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example @@ -3097,7 +3100,7 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example @@ -3115,7 +3118,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3133,9 +3136,9 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3155,12 +3158,12 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | -| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | -| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | +| `available_regions` - [`[Region]`](/reference/graphql/2-4-7/types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example @@ -3169,9 +3172,9 @@ Contains the source and target wish lists after copying products. "available_regions": [Region], "full_name_english": "xyz789", "full_name_locale": "abc123", - "id": "abc123", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "abc123" + "id": "xyz789", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "xyz789" } ``` @@ -3519,7 +3522,7 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example @@ -3537,14 +3540,14 @@ Defines a new gift registry. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | -| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-7/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](/reference/graphql/2-4-7/types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](/reference/graphql/2-4-7/types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/2-4-7/types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](/reference/graphql/2-4-7/types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3555,7 +3558,7 @@ Defines a new gift registry. ], "event_name": "xyz789", "gift_registry_type_uid": "4", - "message": "xyz789", + "message": "abc123", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -3573,7 +3576,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3589,7 +3592,7 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | Optional client-generated ID | #### Example @@ -3623,20 +3626,20 @@ Contains the secure information used to authorize transaction. Applies to Payflo | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | +| `response_message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { "response_message": "abc123", - "result": 987, - "result_code": 123, - "secure_token": "abc123", + "result": 123, + "result_code": 987, + "secure_token": "xyz789", "secure_token_id": "xyz789" } ``` @@ -3651,11 +3654,11 @@ Contains payment order details that are used while processing the payment order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | +| `cartId` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](/reference/graphql/2-4-7/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example @@ -3664,8 +3667,8 @@ Contains payment order details that are used while processing the payment order "cartId": "xyz789", "location": "PRODUCT_DETAIL", "methodCode": "abc123", - "paymentSource": "abc123", - "vaultIntent": true + "paymentSource": "xyz789", + "vaultIntent": false } ``` @@ -3679,21 +3682,21 @@ Contains payment order details that are used while processing the payment order | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | -| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `amount` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the payment order | #### Example ```json { - "amount": 123.45, - "currency_code": "xyz789", - "id": "abc123", - "mp_order_id": "abc123", - "status": "abc123" + "amount": 987.65, + "currency_code": "abc123", + "id": "xyz789", + "mp_order_id": "xyz789", + "status": "xyz789" } ``` @@ -3707,20 +3710,20 @@ Defines a new product review. | Input Field | Description | |-------------|-------------| -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `nickname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](/reference/graphql/2-4-7/types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The review text. | #### Example ```json { - "nickname": "xyz789", + "nickname": "abc123", "ratings": [ProductReviewRatingInput], - "sku": "abc123", - "summary": "abc123", + "sku": "xyz789", + "summary": "xyz789", "text": "xyz789" } ``` @@ -3735,7 +3738,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | +| `review` - [`ProductReview!`](/reference/graphql/2-4-7/types-k-p.md#productreview) | Product review details. | #### Example @@ -3754,7 +3757,7 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example @@ -3773,9 +3776,9 @@ Defines a set of conditions that apply to a rule. | 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!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -3798,15 +3801,15 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { "description": "xyz789", - "name": "xyz789" + "name": "abc123" } ``` @@ -3820,7 +3823,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -3838,8 +3841,8 @@ Defines the name and visibility of a new wish list. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](/reference/graphql/2-4-7/types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -3857,7 +3860,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -3875,19 +3878,19 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | Input Field | Description | |-------------|-------------| -| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | +| `cc_exp_month` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The credit card type. | #### Example ```json { "cc_exp_month": 987, - "cc_exp_year": 987, + "cc_exp_year": 123, "cc_last_4": 987, - "cc_type": "xyz789" + "cc_type": "abc123" } ``` @@ -3901,10 +3904,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-7/types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CreditMemo` object. | | `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | +| `number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -3928,24 +3931,24 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | #### Example ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } ``` @@ -3960,20 +3963,20 @@ Credit memo item details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | +| [`BundleCreditMemoItem`](/reference/graphql/2-4-7/types-a-b.md#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](/reference/graphql/2-4-7/types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -3981,11 +3984,11 @@ Credit memo item details. ```json { "discounts": [Discount], - "id": 4, + "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 } ``` @@ -4000,15 +4003,15 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `adjustment` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The final base grand total amount in the base currency. | | `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | +| `grand_total` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-7/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-7/types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4034,26 +4037,26 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](types-q-s.md#string) | The currency symbol that is displayed by default, such as $. | +| `available_currency_codes` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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", + "available_currency_codes": ["abc123"], + "base_currency_code": "xyz789", "base_currency_symbol": "abc123", "default_display_currecy_code": "xyz789", - "default_display_currecy_symbol": "xyz789", + "default_display_currecy_symbol": "abc123", "default_display_currency_code": "abc123", - "default_display_currency_symbol": "xyz789", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } ``` @@ -4255,7 +4258,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](/reference/graphql/2-4-7/types-a-b.md#attribute) | An array of attributes. | #### Example @@ -4273,36 +4276,36 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-7/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-7/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](types-a-b.md#attributemetadata) | +| [`AttributeMetadata`](/reference/graphql/2-4-7/types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](/reference/graphql/2-4-7/types-q-s.md#returnitemattributemetadata) | #### Example ```json { "code": 4, - "default_value": "abc123", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_required": true, - "is_unique": false, + "is_required": false, + "is_unique": true, "label": "xyz789", "options": [CustomAttributeOptionInterface] } @@ -4316,22 +4319,22 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `is_default` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](/reference/graphql/2-4-7/types-a-b.md#attributeoptionmetadata) | #### Example ```json { - "is_default": true, - "label": "xyz789", + "is_default": false, + "label": "abc123", "value": "xyz789" } ``` @@ -4347,51 +4350,51 @@ Defines the customer name, addresses, and other details. | Field Name | Description | |------------|-------------| | `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](types-t-z.md#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `allow_remote_shopping_assistance` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](/reference/graphql/2-4-7/types-t-z.md#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`](types-q-s.md#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | Details about a specific gift registry. | -| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | Details about a specific gift registry. | +| `group_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's middle name. | | `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](types-q-s.md#rewardpoints) | Customer reward points details. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](/reference/graphql/2-4-7/types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](/reference/graphql/2-4-7/types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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`](/reference/graphql/2-4-7/types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](/reference/graphql/2-4-7/types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](/reference/graphql/2-4-7/types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-f-i.md#id) | ID of the company structure | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `structure_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#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. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/2-4-7/types-t-z.md#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 @@ -4402,21 +4405,21 @@ Defines the customer name, addresses, and other details. "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", + "date_of_birth": "xyz789", + "default_billing": "xyz789", "default_shipping": "xyz789", - "dob": "abc123", - "email": "abc123", - "firstname": "xyz789", - "gender": 987, + "dob": "xyz789", + "email": "xyz789", + "firstname": "abc123", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group_id": 123, "id": 123, - "is_subscribed": true, - "job_title": "abc123", + "is_subscribed": false, + "job_title": "xyz789", "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, @@ -4435,9 +4438,9 @@ Defines the customer name, addresses, and other details. "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "xyz789", - "taxvat": "xyz789", + "structure_id": 4, + "suffix": "abc123", + "taxvat": "abc123", "team": CompanyTeam, "telephone": "xyz789", "wishlist": Wishlist, @@ -4456,29 +4459,29 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's company. | | `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](types-q-s.md#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `country_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | | `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `customer_id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the customer's default shipping address. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `fax` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-f-i.md#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example @@ -4495,18 +4498,18 @@ Contains detailed information about a customer's billing or shipping address. "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "xyz789", - "id": 123, + "firstname": "abc123", + "id": 987, "lastname": "xyz789", - "middlename": "abc123", - "postcode": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "xyz789" + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "abc123" } ``` @@ -4520,14 +4523,14 @@ Specifies the attribute code and value of a customer address attribute. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | +| `attribute_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "xyz789" } ``` @@ -4542,8 +4545,8 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | -| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The value assigned to the attribute. | #### Example @@ -4564,47 +4567,47 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributesV2` - [`[AttributeValueInput]`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `street` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], "custom_attributesV2": [AttributeValueInput], "default_billing": false, - "default_shipping": true, - "fax": "abc123", + "default_shipping": false, + "fax": "xyz789", "firstname": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "middlename": "abc123", "postcode": "abc123", "prefix": "xyz789", "region": CustomerAddressRegionInput, "street": ["xyz789"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "abc123", "vat_id": "abc123" } @@ -4620,9 +4623,9 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -4644,9 +4647,9 @@ Defines the customer's state or province. | Input Field | Description | |-------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -4668,36 +4671,36 @@ Customer attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-7/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-7/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/2-4-7/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of lines of the attribute value. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/2-4-7/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": 4, - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, + "is_required": false, "is_unique": true, "label": "xyz789", "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -4712,38 +4715,38 @@ An input object for creating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", "dob": "xyz789", - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "gender": 987, + "gender": 123, "is_subscribed": false, - "lastname": "xyz789", - "middlename": "abc123", - "password": "xyz789", + "lastname": "abc123", + "middlename": "xyz789", + "password": "abc123", "prefix": "xyz789", - "suffix": "xyz789", + "suffix": "abc123", "taxvat": "xyz789" } ``` @@ -4758,11 +4761,11 @@ Contains details about a single downloadable product. | Field Name | Description | |------------|-------------| -| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | -| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | +| `date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example @@ -4804,34 +4807,34 @@ An input object that assigns or updates customer attributes. | Input Field | Description | |-------------|-------------| -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `date_of_birth` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "dob": "xyz789", - "email": "xyz789", - "firstname": "xyz789", - "gender": 123, + "email": "abc123", + "firstname": "abc123", + "gender": 987, "is_subscribed": false, "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "password": "abc123", - "prefix": "xyz789", - "suffix": "xyz789", + "prefix": "abc123", + "suffix": "abc123", "taxvat": "xyz789" } ``` @@ -4846,34 +4849,34 @@ Contains details about each of the customer's orders. | Field Name | Description | |------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | -| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `applied_coupons` - [`[AppliedCoupon]!`](/reference/graphql/2-4-7/types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `billing_address` - [`OrderAddress`](/reference/graphql/2-4-7/types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-7/types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | | `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `email` - [`String`](types-q-s.md#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | -| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](types-q-s.md#string) | The order number. | -| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | -| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | -| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | -| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | -| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](/reference/graphql/2-4-7/types-f-i.md#invoice) | A list of invoices for the order. | +| `items` - [`[OrderItemInterface]`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `payment_methods` - [`[OrderPaymentMethod]`](/reference/graphql/2-4-7/types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](/reference/graphql/2-4-7/types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](/reference/graphql/2-4-7/types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](/reference/graphql/2-4-7/types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](/reference/graphql/2-4-7/types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -4885,26 +4888,26 @@ Contains details about each of the customer's orders. "comments": [SalesCommentItem], "created_at": "abc123", "credit_memos": [CreditMemo], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "grand_total": 123.45, "id": 4, - "increment_id": "xyz789", + "increment_id": "abc123", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", + "number": "xyz789", "order_date": "xyz789", - "order_number": "abc123", + "order_number": "xyz789", "payment_methods": [OrderPaymentMethod], "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 } @@ -4920,7 +4923,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -4959,8 +4962,8 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The total count of customer orders. | #### Example @@ -4968,7 +4971,7 @@ The collection of orders that match the conditions defined in the filter. { "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -4982,7 +4985,7 @@ Identifies the filter to use for filtering orders. | Input Field | Description | |-------------|-------------| -| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `number` - [`FilterStringTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterstringtypeinput) | Filters by order number. | #### Example @@ -5018,7 +5021,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](/reference/graphql/2-4-7/types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5037,8 +5040,8 @@ Contains store credit information with balance and history. | 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`](types-k-p.md#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | +| `current_balance` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5046,7 +5049,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": false + "enabled": true } ``` @@ -5061,8 +5064,8 @@ Lists changes to the amount of store credit available to the customer. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of items returned. | #### Example @@ -5084,16 +5087,16 @@ Contains store credit history information. | Field Name | Description | |------------|-------------| -| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | +| `action` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time when the store credit change was made. | #### Example ```json { - "action": "xyz789", + "action": "abc123", "actual_balance": Money, "balance_change": Money, "date_time_changed": "xyz789" @@ -5110,12 +5113,12 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | +| `token` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer authorization token. | #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -5128,34 +5131,34 @@ An input object for updating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Deprecated: Use `date_of_birth` instead. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "dob": "xyz789", - "firstname": "abc123", + "firstname": "xyz789", "gender": 987, "is_subscribed": true, - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "prefix": "xyz789", - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "xyz789" } ``` @@ -5170,24 +5173,24 @@ Contains information about a text area that is defined as part of a customizable | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "option_id": 123, + "option_id": 987, "product_sku": "xyz789", "required": false, "sort_order": 987, "title": "xyz789", - "uid": "4", + "uid": 4, "value": CustomizableAreaValue } ``` @@ -5202,21 +5205,21 @@ Defines the price and sku of a product whose page contains a customized text are | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | +| `max_characters` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "max_characters": 987, + "max_characters": 123, "price": 987.65, "price_type": "FIXED", "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -5230,21 +5233,21 @@ Contains information about a set of checkbox values that are defined as part of | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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, + "option_id": 123, + "required": false, "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": "4", "value": [CustomizableCheckboxValue] } @@ -5260,13 +5263,13 @@ Defines the price and sku of a product whose page contains a customized set of c | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example @@ -5275,10 +5278,10 @@ Defines the price and sku of a product whose page contains a customized set of c "option_type_id": 987, "price": 987.65, "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "xyz789", - "uid": 4 + "sku": "xyz789", + "sort_order": 123, + "title": "abc123", + "uid": "4" } ``` @@ -5292,12 +5295,12 @@ Contains information about a date picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | #### Example @@ -5305,11 +5308,11 @@ Contains information about a date picker that is defined as part of a customizab ```json { "option_id": 987, - "product_sku": "xyz789", - "required": false, + "product_sku": "abc123", + "required": true, "sort_order": 987, "title": "abc123", - "uid": "4", + "uid": 4, "value": CustomizableDateValue } ``` @@ -5344,21 +5347,21 @@ Defines the price and sku of a product whose page contains a customized date pic | Field Name | Description | |------------|-------------| -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | | `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "type": "DATE", - "uid": "4" + "uid": 4 } ``` @@ -5372,11 +5375,11 @@ Contains information about a drop down menu that is defined as part of a customi | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -5384,10 +5387,10 @@ Contains information about a drop down menu that is defined as part of a customi ```json { "option_id": 123, - "required": false, + "required": true, "sort_order": 987, - "title": "abc123", - "uid": "4", + "title": "xyz789", + "uid": 4, "value": [CustomizableDropDownValue] } ``` @@ -5402,23 +5405,23 @@ Defines the price and sku of a product whose page contains a customized drop dow | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { "option_type_id": 123, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "xyz789", - "sort_order": 987, + "sort_order": 123, "title": "abc123", "uid": 4 } @@ -5434,23 +5437,23 @@ Contains information about a text field that is defined as part of a customizabl | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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", + "option_id": 987, + "product_sku": "xyz789", "required": true, - "sort_order": 987, - "title": "abc123", + "sort_order": 123, + "title": "xyz789", "uid": "4", "value": CustomizableFieldValue } @@ -5466,21 +5469,21 @@ Defines the price and sku of a product whose page contains a customized text fie | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | +| `max_characters` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { "max_characters": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" + "sku": "abc123", + "uid": 4 } ``` @@ -5494,12 +5497,12 @@ Contains information about a file picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -5508,10 +5511,10 @@ Contains information about a file picker that is defined as part of a customizab { "option_id": 987, "product_sku": "abc123", - "required": true, - "sort_order": 123, + "required": false, + "sort_order": 987, "title": "abc123", - "uid": "4", + "uid": 4, "value": CustomizableFileValue } ``` @@ -5526,25 +5529,25 @@ Defines the price and sku of a product whose page contains a customized file pic | Field Name | Description | |------------|-------------| -| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | -| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | +| `file_extension` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "file_extension": "xyz789", + "file_extension": "abc123", "image_size_x": 987, - "image_size_y": 987, + "image_size_y": 123, "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5558,22 +5561,22 @@ Contains information about a multiselect that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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": 123, + "option_id": 123, + "required": true, + "sort_order": 987, "title": "abc123", - "uid": 4, + "uid": "4", "value": [CustomizableMultipleValue] } ``` @@ -5588,13 +5591,13 @@ Defines the price and sku of a product whose page contains a customized multisel | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example @@ -5603,10 +5606,10 @@ Defines the price and sku of a product whose page contains a customized multisel "option_type_id": 987, "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5620,16 +5623,16 @@ Defines a customizable option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The customizable option ID of the product. | +| `uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The string value of the option. | #### Example ```json { - "id": 123, - "uid": 4, + "id": 987, + "uid": "4", "value_string": "abc123" } ``` @@ -5644,11 +5647,11 @@ Contains basic information about a customizable option. It can be implemented by | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -5668,10 +5671,10 @@ Contains basic information about a customizable option. It can be implemented by ```json { "option_id": 123, - "required": false, + "required": true, "sort_order": 987, - "title": "xyz789", - "uid": 4 + "title": "abc123", + "uid": "4" } ``` @@ -5691,12 +5694,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`VirtualProduct`](/reference/graphql/2-4-7/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-7/types-q-s.md#simpleproduct) | | [`ConfigurableProduct`](#configurableproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`BundleProduct`](/reference/graphql/2-4-7/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-7/types-f-i.md#giftcardproduct) | #### Example @@ -5714,22 +5717,22 @@ Contains information about a set of radio buttons that are defined as part of a | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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, + "option_id": 987, + "required": true, + "sort_order": 123, "title": "xyz789", - "uid": "4", + "uid": 4, "value": [CustomizableRadioValue] } ``` @@ -5744,25 +5747,25 @@ Defines the price and sku of a product whose page contains a customized set of r | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-7/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 123.45, "price_type": "FIXED", "sku": "abc123", "sort_order": 123, "title": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -5776,12 +5779,12 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -5794,12 +5797,12 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -5812,12 +5815,12 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -5830,12 +5833,12 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example ```json -{"result": true} +{"result": false} ``` @@ -5846,9 +5849,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-7/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-7/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-7/types-f-i.md#internalerror) | #### Example @@ -5867,7 +5870,7 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -5886,7 +5889,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/2-4-7/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -5905,12 +5908,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -5921,12 +5924,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -5939,9 +5942,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/2-4-7/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/2-4-7/types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -5966,14 +5969,14 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example ```json { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } ``` @@ -5987,7 +5990,7 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The text of the error message. | +| `message` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example @@ -6023,7 +6026,7 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example @@ -6059,7 +6062,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6077,8 +6080,8 @@ Indicates whether the request to delete the requisition list was successful. | Field Name | Description | |------------|-------------| -| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | +| `requisition_lists` - [`RequisitionLists`](/reference/graphql/2-4-7/types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example @@ -6096,8 +6099,8 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example @@ -6115,13 +6118,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of the discount. | | `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | -| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | +| `coupon` - [`AppliedCoupon`](/reference/graphql/2-4-7/types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6130,9 +6133,9 @@ Specifies the discount type and value for quote line item. "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": true, - "label": "xyz789", - "type": "xyz789", + "is_discounting_locked": false, + "label": "abc123", + "type": "abc123", "value": 987.65 } ``` @@ -6147,21 +6150,21 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `max_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -6170,18 +6173,18 @@ An implementation for downloadable product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "abc123", + "id": "xyz789", "is_available": true, "links": [DownloadableProductLinks], - "max_qty": 987.65, - "min_qty": 123.45, + "max_qty": 123.45, + "min_qty": 987.65, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -6197,12 +6200,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | #### Example @@ -6212,10 +6215,10 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } ``` @@ -6248,12 +6251,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6261,11 +6264,11 @@ Defines downloadable product options for `InvoiceItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 123.45 } ``` @@ -6280,16 +6283,16 @@ Defines characteristics of the links for downloadable product. | Field Name | Description | |------------|-------------| -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json { "sort_order": 987, - "title": "xyz789", + "title": "abc123", "uid": 4 } ``` @@ -6306,25 +6309,25 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-7/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-7/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the order item. | #### Example @@ -6340,15 +6343,15 @@ Defines downloadable product options for `OrderItemInterface`. "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "abc123", "product_url_key": "abc123", "quantity_canceled": 123.45, "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, + "quantity_ordered": 987.65, + "quantity_refunded": 123.45, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" } @@ -6364,73 +6367,73 @@ Defines a product that the shopper downloads. | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `color` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-7/types-k-p.md#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`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `gift_message_available` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `options_container` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-7/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-7/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-7/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#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, +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-7/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-7/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-7/types-t-z.md#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": "xyz789", "categories": [CategoryInterface], "color": 123, @@ -6445,30 +6448,30 @@ Defines a product that the shopper downloads. "downloadable_product_samples": [ DownloadableProductSamples ], - "gift_message_available": "xyz789", + "gift_message_available": "abc123", "id": 123, "image": ProductImage, - "is_returnable": "abc123", - "links_purchased_separately": 123, + "is_returnable": "xyz789", + "links_purchased_separately": 987, "links_title": "xyz789", "manufacturer": 987, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", "meta_title": "xyz789", "name": "abc123", "new_from_date": "abc123", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "xyz789", "review_count": 123, @@ -6476,24 +6479,24 @@ Defines a product that the shopper downloads. "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 123.45, "special_to_date": "xyz789", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website] } ``` @@ -6534,17 +6537,17 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](types-a-b.md#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | +| `sample_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example @@ -6555,11 +6558,11 @@ Defines characteristics of a downloadable product. "link_type": "FILE", "number_of_downloads": 987, "price": 123.45, - "sample_file": "xyz789", + "sample_file": "abc123", "sample_type": "FILE", "sample_url": "xyz789", - "sort_order": 123, - "title": "xyz789", + "sort_order": 987, + "title": "abc123", "uid": 4 } ``` @@ -6574,7 +6577,7 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example @@ -6592,22 +6595,22 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | +| `sample_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the sample. | #### Example ```json { - "id": 123, - "sample_file": "xyz789", + "id": 987, + "sample_file": "abc123", "sample_type": "FILE", "sample_url": "xyz789", - "sort_order": 123, + "sort_order": 987, "title": "xyz789" } ``` @@ -6622,12 +6625,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of the product added to the requisition list. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -6636,9 +6639,9 @@ Contains details about downloadable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "links": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -6652,22 +6655,22 @@ A downloadable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `added_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | | `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": 4, "links_v2": [DownloadableProductLinks], "product": ProductInterface, @@ -6686,8 +6689,8 @@ Identifies a quote to be duplicated | Input Field | Description | |-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | +| `duplicated_quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | ID of the quote to be duplicated. | #### Example @@ -6705,7 +6708,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -6724,7 +6727,7 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example @@ -6785,8 +6788,8 @@ Contains an array of dynamic blocks. | Field Name | Description | |------------|-------------| | `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -6794,7 +6797,7 @@ Contains an array of dynamic blocks. { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -6808,7 +6811,7 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](types-f-i.md#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](/reference/graphql/2-4-7/types-f-i.md#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. | @@ -6828,14 +6831,14 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The text or other entered value. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "abc123" } ``` @@ -6850,8 +6853,8 @@ Defines a customer-entered option. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Text the customer entered. | #### Example @@ -6869,21 +6872,21 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "canonical_url": "xyz789", - "entity_uid": "4", + "canonical_url": "abc123", + "entity_uid": 4, "id": 987, - "redirectCode": 123, + "redirectCode": 987, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -6897,20 +6900,20 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-7/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-7/types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-7/types-k-p.md#negotiablequoteinvalidstateerror) | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -6924,7 +6927,7 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -6932,7 +6935,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput } ``` @@ -6946,8 +6949,8 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](/reference/graphql/2-4-7/types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example @@ -6987,13 +6990,13 @@ Lists the exchange rate. | Field Name | Description | |------------|-------------| -| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | +| `currency_to` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "xyz789", "rate": 987.65} +{"currency_to": "abc123", "rate": 123.45} ``` @@ -7006,7 +7009,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID to assign to the cart. | #### 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 33b58c538..8daa8da37 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 @@ -8,8 +8,8 @@ Defines a filter that matches the input exactly. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"]`. | +| `eq` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -47,7 +47,7 @@ Defines a filter that performs a fuzzy search. | Input Field | Description | |-------------|-------------| -| `match` - [`String`](types-q-s.md#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` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -66,8 +66,8 @@ Defines a filter that matches a range of values, such as prices or dates. | Input Field | Description | |-------------|-------------| -| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | +| `from` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example @@ -88,17 +88,17 @@ Defines a filter for an input string. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | +| `eq` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example ```json { - "eq": "xyz789", + "eq": "abc123", "in": ["xyz789"], - "match": "abc123" + "match": "xyz789" } ``` @@ -112,41 +112,41 @@ Defines the comparison operators that can be used in a filter. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Equals. | -| `finset` - [`[String]`](types-q-s.md#string) | | -| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](types-q-s.md#string) | Greater than. | -| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | -| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](types-q-s.md#string) | Less than. | -| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | -| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | -| `neq` - [`String`](types-q-s.md#string) | Not equal to. | -| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](types-q-s.md#string) | Not null. | -| `null` - [`String`](types-q-s.md#string) | Is null. | -| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | +| `eq` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `from` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Less than. | +| `lteq` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Not null. | +| `null` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Is null. | +| `to` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { - "eq": "abc123", + "eq": "xyz789", "finset": ["xyz789"], - "from": "abc123", - "gt": "abc123", + "from": "xyz789", + "gt": "xyz789", "gteq": "xyz789", - "in": ["abc123"], - "like": "abc123", + "in": ["xyz789"], + "like": "xyz789", "lt": "abc123", "lteq": "abc123", - "moreq": "xyz789", - "neq": "xyz789", + "moreq": "abc123", + "neq": "abc123", "nin": ["abc123"], - "notnull": "abc123", - "null": "xyz789", - "to": "xyz789" + "notnull": "xyz789", + "null": "abc123", + "to": "abc123" } ``` @@ -160,8 +160,8 @@ A single FPT that can be applied to a product price. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | +| `amount` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example @@ -205,7 +205,7 @@ values as specified by #### Example ```json -987.65 +123.45 ``` @@ -218,7 +218,7 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example @@ -236,12 +236,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | +| `customer_token` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "abc123"} +{"customer_token": "xyz789"} ``` @@ -277,7 +277,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": 4} +{"negotiable_quote_uid": "4"} ``` @@ -290,7 +290,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](/reference/graphql/2-4-7/types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -308,16 +308,16 @@ Contains details about the gift card account. | Field Name | Description | |------------|-------------| -| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `balance` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "xyz789" } ``` @@ -332,7 +332,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The applied gift card code. | #### Example @@ -363,8 +363,8 @@ Contains the value of a gift card, the website that generated the card, and rela { "attribute_id": 987, "uid": 4, - "value": 123.45, - "value_id": 123, + "value": 987.65, + "value_id": 987, "website_id": 987, "website_value": 987.65 } @@ -380,24 +380,24 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount and currency of the gift card. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount and currency of the gift card. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-7/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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`](types-q-s.md#string) | The message from the sender to the recipient. | +| `message` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-7/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about an item in the cart. | | `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | -| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `recipient_email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -410,7 +410,7 @@ Contains details about a gift card that has been added to a cart. "errors": [CartItemError], "id": "abc123", "is_available": true, - "max_qty": 123.45, + "max_qty": 987.65, "message": "xyz789", "min_qty": 987.65, "note_from_buyer": [ItemNote], @@ -418,11 +418,11 @@ Contains details about a gift card that has been added to a cart. "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "recipient_email": "abc123", + "recipient_email": "xyz789", "recipient_name": "xyz789", "sender_email": "xyz789", "sender_name": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -434,13 +434,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#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`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -451,9 +451,9 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 123.45 } ``` @@ -466,13 +466,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -483,10 +483,10 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "product_sku": "abc123", + "quantity_invoiced": 987.65 } ``` @@ -500,11 +500,11 @@ Contains details about a gift card. | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | +| `message` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example @@ -512,9 +512,9 @@ Contains details about a gift card. { "message": "xyz789", "recipient_email": "abc123", - "recipient_name": "xyz789", + "recipient_name": "abc123", "sender_email": "abc123", - "sender_name": "xyz789" + "sender_name": "abc123" } ``` @@ -528,13 +528,13 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | +| `amount` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -542,9 +542,9 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "abc123", - "recipient_name": "xyz789", + "message": "abc123", + "recipient_email": "xyz789", + "recipient_name": "abc123", "sender_email": "abc123", "sender_name": "xyz789" } @@ -558,27 +558,27 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-7/types-k-p.md#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`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-7/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the order item. | #### Example @@ -592,16 +592,16 @@ Contains details about the sender, recipient, and amount of a gift card. "gift_wrapping": GiftWrapping, "id": "4", "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "xyz789", "product_url_key": "abc123", - "quantity_canceled": 123.45, + "quantity_canceled": 987.65, "quantity_invoiced": 987.65, "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_returned": 987.65, + "quantity_refunded": 123.45, + "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "abc123" @@ -618,73 +618,73 @@ Defines properties of a gift card. | Field Name | Description | |------------|-------------| -| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](types-a-b.md#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `allow_message` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](/reference/graphql/2-4-7/types-c-e.md#categoryinterface) | The categories assigned to a product. | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-7/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](/reference/graphql/2-4-7/types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-7/types-k-p.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-7/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-7/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-7/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-7/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-7/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/2-4-7/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-7/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-7/types-t-z.md#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 @@ -703,27 +703,27 @@ Defines properties of a gift card. "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": "xyz789", + "gift_message_available": "abc123", "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", "id": 123, "image": ProductImage, - "is_redeemable": false, + "is_redeemable": true, "is_returnable": "abc123", "lifetime": 987, - "manufacturer": 987, + "manufacturer": 123, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 123, + "message_max_length": 987, "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", "name": "xyz789", "new_from_date": "abc123", "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, - "open_amount_max": 987.65, - "open_amount_min": 123.45, + "open_amount_max": 123.45, + "open_amount_min": 987.65, "options": [CustomizableOptionInterface], "options_container": "xyz789", "price": ProductPrices, @@ -731,32 +731,32 @@ Defines properties of a gift card. "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "rating_summary": 987.65, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, + "special_from_date": "xyz789", + "special_price": 987.65, "special_to_date": "xyz789", - "staged": false, + "staged": true, "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": "4", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "xyz789", + "url_key": "abc123", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website], "weight": 987.65 } @@ -772,9 +772,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -785,8 +785,8 @@ Contains details about gift cards added to a requisition list. "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -800,10 +800,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -811,12 +811,12 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "product_sku": "xyz789", + "quantity_shipped": 123.45 } ``` @@ -850,19 +850,19 @@ A single gift card added to a wish list. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "gift_card_options": GiftCardOptions, @@ -882,15 +882,15 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | Sender name | -| `message` - [`String!`](types-q-s.md#string) | Gift message text | -| `to` - [`String!`](types-q-s.md#string) | Recipient name | +| `from` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Sender name | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Gift message text | +| `to` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "abc123", + "from": "xyz789", "message": "xyz789", "to": "abc123" } @@ -906,9 +906,9 @@ Defines a gift message. | Input Field | Description | |-------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | -| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | -| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | +| `from` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the recepient. | #### Example @@ -916,7 +916,7 @@ Defines a gift message. { "from": "abc123", "message": "xyz789", - "to": "xyz789" + "to": "abc123" } ``` @@ -930,9 +930,9 @@ Contains prices for gift wrapping options. | Field Name | Description | |------------|-------------| -| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | -| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | +| `gift_wrapping_for_items` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_order` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `printed_card` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | Price for the printed card. | #### Example @@ -954,15 +954,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-q-s.md#string) | The name of the event. | +| `event_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the event. | | `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](types-q-s.md#string) | The customer who created the gift registry. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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`](types-c-e.md#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `shipping_address` - [`CustomerAddress`](/reference/graphql/2-4-7/types-c-e.md#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. | @@ -971,18 +971,18 @@ Contains details about a gift registry. ```json { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [GiftRegistryDynamicAttribute], "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "xyz789", + "message": "abc123", "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } ``` @@ -996,14 +996,14 @@ Contains details about a gift registry. |------------|-------------| | `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!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": 4, + "code": "4", "group": "EVENT_INFORMATION", "label": "abc123", "value": "xyz789" @@ -1044,15 +1044,12 @@ Defines a dynamic attribute. | Input Field | Description | |-------------|-------------| | `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example ```json -{ - "code": "4", - "value": "abc123" -} +{"code": 4, "value": "xyz789"} ``` @@ -1064,8 +1061,8 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1078,9 +1075,9 @@ Defines a dynamic attribute. ```json { - "code": 4, - "label": "xyz789", - "value": "xyz789" + "code": "4", + "label": "abc123", + "value": "abc123" } ``` @@ -1092,11 +1089,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Example @@ -1105,10 +1102,10 @@ Defines a dynamic attribute. { "attribute_group": "xyz789", "code": "4", - "input_type": "xyz789", - "is_required": false, - "label": "abc123", - "sort_order": 987 + "input_type": "abc123", + "is_required": true, + "label": "xyz789", + "sort_order": 123 } ``` @@ -1120,11 +1117,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1137,9 +1134,9 @@ Defines a dynamic attribute. ```json { - "attribute_group": "xyz789", - "code": "4", - "input_type": "xyz789", + "attribute_group": "abc123", + "code": 4, + "input_type": "abc123", "is_required": false, "label": "xyz789", "sort_order": 987 @@ -1154,9 +1151,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#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. | @@ -1165,11 +1162,11 @@ Defines a dynamic attribute. ```json { - "created_at": "xyz789", - "note": "xyz789", + "created_at": "abc123", + "note": "abc123", "product": ProductInterface, "quantity": 123.45, - "quantity_fulfilled": 123.45, + "quantity_fulfilled": 987.65, "uid": 4 } ``` @@ -1182,9 +1179,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#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. | @@ -1202,9 +1199,9 @@ Defines a dynamic attribute. "created_at": "abc123", "note": "xyz789", "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 987.65, - "uid": "4" + "quantity": 987.65, + "quantity_fulfilled": 123.45, + "uid": 4 } ``` @@ -1218,14 +1215,14 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-7/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1249,7 +1246,7 @@ Contains details about an error that occurred when processing a gift registry it | `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!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1259,7 +1256,7 @@ Contains details about an error that occurred when processing a gift registry it "code": "OUT_OF_STOCK", "gift_registry_item_uid": "4", "gift_registry_uid": 4, - "message": "abc123", + "message": "xyz789", "product_uid": "4" } ``` @@ -1300,7 +1297,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-7/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1338,9 +1335,9 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1353,7 +1350,7 @@ Contains details about a registrant. "email": "xyz789", "firstname": "abc123", "lastname": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1366,8 +1363,8 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A corresponding value for the code. | #### Example @@ -1375,7 +1372,7 @@ Contains details about a registrant. { "code": 4, "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -1389,23 +1386,23 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | -| `event_title` - [`String!`](types-q-s.md#string) | The title given to the event. | +| `event_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The title given to the event. | | `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](types-q-s.md#string) | The location of the event. | -| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | -| `type` - [`String`](types-q-s.md#string) | The type of event being held. | +| `location` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of event being held. | #### Example ```json { "event_date": "xyz789", - "event_title": "xyz789", + "event_title": "abc123", "gift_registry_uid": "4", "location": "xyz789", "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ``` @@ -1419,16 +1416,13 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](/reference/graphql/2-4-7/types-c-e.md#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" -} +{"address_data": CustomerAddressInput, "address_id": 4} ``` @@ -1461,7 +1455,7 @@ Contains details about a gift registry type. | 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!`](types-q-s.md#string) | The label assigned to the gift registry type on the Admin. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -1472,7 +1466,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1486,10 +1480,10 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](types-q-s.md#string) | The name of the gift wrapping design. | +| `design` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-k-p.md#money) | The gift wrapping price. | +| `price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example @@ -1497,10 +1491,10 @@ Contains details about the selected or available gift wrapping options. ```json { "design": "xyz789", - "id": "4", + "id": 4, "image": GiftWrappingImage, "price": Money, - "uid": "4" + "uid": 4 } ``` @@ -1514,15 +1508,15 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | -| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The gift wrapping preview image URL. | #### Example ```json { - "label": "xyz789", - "url": "abc123" + "label": "abc123", + "url": "xyz789" } ``` @@ -1534,17 +1528,17 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | +| `color` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](types-q-s.md#string) | The button type | +| `type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The button type | #### Example ```json { - "color": "abc123", + "color": "xyz789", "height": 123, - "type": "xyz789" + "type": "abc123" } ``` @@ -1557,13 +1551,13 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| | `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-7/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -1575,7 +1569,7 @@ Points to an image associated with a gift wrapping option. "payment_intent": "xyz789", "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "title": "abc123" } ``` @@ -1590,9 +1584,9 @@ Google Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | PayPal order ID | #### Example @@ -1600,7 +1594,7 @@ Google Pay inputs { "payment_source": "xyz789", "payments_order_id": "abc123", - "paypal_order_id": "xyz789" + "paypal_order_id": "abc123" } ``` @@ -1615,69 +1609,69 @@ Defines a grouped product, which consists of simple standalone products that are | 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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](/reference/graphql/2-4-7/types-c-e.md#categoryinterface) | The categories assigned to a product. | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-7/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for new product listings. | | `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `options_container` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-7/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-7/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-7/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-7/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/2-4-7/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-7/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-7/types-t-z.md#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, + "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], "color": 123, @@ -1687,20 +1681,20 @@ Defines a grouped product, which consists of simple standalone products that are "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": "xyz789", - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", "items": [GroupedProductItem], - "manufacturer": 987, + "manufacturer": 123, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", "meta_keyword": "abc123", "meta_title": "abc123", "name": "abc123", - "new_from_date": "xyz789", + "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, @@ -1716,20 +1710,20 @@ Defines a grouped product, which consists of simple standalone products that are "sku": "abc123", "small_image": ProductImage, "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", - "uid": 4, + "type_id": "xyz789", + "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", @@ -1749,14 +1743,14 @@ Contains information about an individual grouped product item. | Field Name | Description | |------------|-------------| | `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example ```json { - "position": 987, + "position": 123, "product": ProductInterface, "qty": 987.65 } @@ -1772,18 +1766,18 @@ A grouped product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the item. | | `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": 4, @@ -1800,31 +1794,31 @@ A grouped product wish list item. | Field Name | Description | |------------|-------------| -| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds` - [`Boolean`](types-a-b.md#boolean) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `cc_vault_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-7/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | 3DS mode | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "cc_vault_code": "xyz789", + "cc_vault_code": "abc123", "code": "abc123", - "is_vault_enabled": false, - "is_visible": true, + "is_vault_enabled": true, + "is_visible": false, "payment_intent": "xyz789", - "payment_source": "abc123", + "payment_source": "xyz789", "requires_card_details": true, "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "three_ds": true, "title": "abc123" } @@ -1840,28 +1834,28 @@ Hosted Fields payment inputs | Input Field | Description | |-------------|-------------| -| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | -| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `holderName` - [`String`](types-q-s.md#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `cardBin` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | PayPal order ID | #### Example ```json { - "cardBin": "xyz789", + "cardBin": "abc123", "cardExpiryMonth": "xyz789", "cardExpiryYear": "abc123", - "cardLast4": "abc123", + "cardLast4": "xyz789", "holderName": "abc123", - "is_active_payment_token_enabler": false, - "payment_source": "xyz789", - "payments_order_id": "abc123", + "is_active_payment_token_enabler": true, + "payment_source": "abc123", + "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } ``` @@ -1876,14 +1870,14 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](/reference/graphql/2-4-7/types-q-s.md#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", + "cancel_url": "abc123", "return_url": "abc123" } ``` @@ -1898,7 +1892,7 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The secure URL generated by PayPal. | #### Example @@ -1916,7 +1910,7 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example @@ -1934,14 +1928,14 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | A parameter name. | -| `value` - [`String`](types-q-s.md#string) | A parameter value. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A parameter name. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A parameter value. | #### Example ```json { - "name": "xyz789", + "name": "abc123", "value": "abc123" } ``` @@ -1959,7 +1953,7 @@ When expected as an input type, any string (such as `"4"`) or integer #### Example ```json -"4" +4 ``` @@ -1970,8 +1964,8 @@ When expected as an input type, any string (such as `"4"`) or integer | Field Name | Description | |------------|-------------| -| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `thumbnail` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -2027,12 +2021,12 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -2045,10 +2039,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-7/types-q-s.md#salescommentitem) | Comments on the invoice. | | `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | | `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | +| `number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2058,7 +2052,7 @@ Contains invoice details. "comments": [SalesCommentItem], "id": "4", "items": [InvoiceItemInterface], - "number": "abc123", + "number": "xyz789", "total": InvoiceTotal } ``` @@ -2071,12 +2065,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2084,12 +2078,12 @@ Contains invoice details. ```json { "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -2103,20 +2097,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](/reference/graphql/2-4-7/types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](/reference/graphql/2-4-7/types-a-b.md#bundleinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2125,12 +2119,12 @@ Contains detailes about invoiced items. ```json { "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -2144,14 +2138,14 @@ Contains price details from an invoice. | Field Name | Description | |------------|-------------| -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | +| `base_grand_total` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-7/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-7/types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2178,7 +2172,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2196,12 +2190,12 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2214,12 +2208,12 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example ```json -{"is_role_name_available": true} +{"is_role_name_available": false} ``` @@ -2232,12 +2226,12 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2250,7 +2244,7 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example @@ -2268,11 +2262,11 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](types-q-s.md#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | Note text. | +| `note` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example @@ -2280,10 +2274,10 @@ The note object for quote line item. ```json { "created_at": "xyz789", - "creator_id": 987, - "creator_type": 987, - "negotiable_quote_item_uid": "4", - "note": "xyz789", + "creator_id": 123, + "creator_type": 123, + "negotiable_quote_item_uid": 4, + "note": "abc123", "note_uid": "4" } ``` @@ -2299,7 +2293,7 @@ A list of options of the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](types-q-s.md#string) | The label of the option. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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. | @@ -2307,9 +2301,9 @@ A list of options of the selected bundle product. ```json { - "id": "4", - "label": "xyz789", - "uid": 4, + "id": 4, + "label": "abc123", + "uid": "4", "values": [ItemSelectedBundleOptionValue] } ``` @@ -2325,9 +2319,9 @@ A list of values for the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | -| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the child bundle product. | +| `price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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. | @@ -2337,7 +2331,7 @@ A list of values for the selected bundle product. { "id": "4", "price": Money, - "product_name": "xyz789", + "product_name": "abc123", "product_sku": "xyz789", "quantity": 123.45, "uid": "4" diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md index f76a27757..e95d0e239 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md @@ -8,14 +8,14 @@ Contains a key-value pair. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | -| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value part of the key/value pair. | #### Example ```json { - "name": "abc123", + "name": "xyz789", "value": "xyz789" } ``` @@ -31,16 +31,16 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| | `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | +| `filter_items_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | #### Example ```json { "filter_items": [LayerFilterItemInterface], - "filter_items_count": 987, + "filter_items_count": 123, "name": "xyz789", "request_var": "xyz789" } @@ -54,17 +54,17 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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" + "items_count": 123, + "label": "abc123", + "value_string": "xyz789" } ``` @@ -76,16 +76,16 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#swatchlayerfilteritem) | +| [`SwatchLayerFilterItem`](/reference/graphql/2-4-7/types-q-s.md#swatchlayerfilteritem) | #### Example @@ -107,9 +107,9 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `note` - [`String`](types-q-s.md#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `note` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -117,7 +117,7 @@ Sets quote item note. { "note": "xyz789", "quote_item_uid": "4", - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -132,14 +132,14 @@ Defines characteristics about images and videos associated with a specific produ | Field Name | Description | |------------|-------------| | `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | -| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -147,14 +147,14 @@ Defines characteristics about images and videos associated with a specific produ ```json { "content": ProductMediaGalleryEntriesContent, - "disabled": true, - "file": "xyz789", + "disabled": false, + "file": "abc123", "id": 123, "label": "xyz789", "media_type": "abc123", "position": 987, - "types": ["abc123"], - "uid": 4, + "types": ["xyz789"], + "uid": "4", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -169,10 +169,10 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -186,7 +186,7 @@ Contains basic information about a product image or video. ```json { "disabled": true, - "label": "abc123", + "label": "xyz789", "position": 123, "url": "abc123" } @@ -200,7 +200,7 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example @@ -216,14 +216,14 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `layout` - [`String`](types-q-s.md#string) | The message layout | +| `layout` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "layout": "abc123", + "layout": "xyz789", "logo": MessageStyleLogo } ``` @@ -238,8 +238,8 @@ Defines a monetary value, including a numeric value and a currency code. | Field Name | Description | |------------|-------------| -| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | +| `currency` - [`CurrencyEnum`](/reference/graphql/2-4-7/types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | A number expressing a monetary value. | #### Example @@ -257,16 +257,16 @@ Contains the customer's gift registry and any errors encountered. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](/reference/graphql/2-4-7/types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example ```json { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -281,12 +281,12 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -299,8 +299,8 @@ Output of the request to move items to another requisition list. | Field Name | Description | |------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | +| `destination_requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -321,14 +321,18 @@ Move Line Item to Requisition List. | Input Field | Description | |-------------|-------------| -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | +| `quote_item_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json -{"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4} +{ + "quote_item_uid": "4", + "quote_uid": "4", + "requisition_list_uid": 4 +} ``` @@ -359,9 +363,9 @@ Contains the source and target wish lists after moving products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -383,23 +387,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/2-4-7/types-a-b.md#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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](types-q-s.md#string) | The email address of the company user. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/2-4-7/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](/reference/graphql/2-4-7/types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-f-i.md#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -410,18 +414,18 @@ Contains details about a negotiable quote. "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "email": "xyz789", + "email": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "xyz789", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", - "total_quantity": 987.65, - "uid": "4", - "updated_at": "abc123" + "total_quantity": 123.45, + "uid": 4, + "updated_at": "xyz789" } ``` @@ -435,15 +439,15 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The address country code. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The address country code. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the region. | #### Example ```json { - "code": "xyz789", - "label": "xyz789" + "code": "abc123", + "label": "abc123" } ``` @@ -457,33 +461,33 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company name. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "abc123", "firstname": "xyz789", "lastname": "abc123", "postcode": "xyz789", - "region": "abc123", - "region_id": 987, - "save_in_address_book": false, - "street": ["abc123"], - "telephone": "abc123" + "region": "xyz789", + "region_id": 123, + "save_in_address_book": true, + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -495,15 +499,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -516,14 +520,14 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "firstname": "abc123", "lastname": "abc123", - "postcode": "xyz789", + "postcode": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "telephone": "abc123" } ``` @@ -538,15 +542,15 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The address region code. | -| `label` - [`String`](types-q-s.md#string) | The display name of the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The address region code. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "label": "abc123", "region_id": 987 } @@ -560,29 +564,29 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's telephone number. | #### Example ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", "lastname": "xyz789", - "postcode": "xyz789", + "postcode": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -597,9 +601,9 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example @@ -608,7 +612,7 @@ Defines the billing address. "address": NegotiableQuoteAddressInput, "customer_address_uid": 4, "same_as_shipping": true, - "use_for_shipping": true + "use_for_shipping": false } ``` @@ -623,10 +627,10 @@ Contains a single plain text comment from either the buyer or seller. | Field Name | Description | |------------|-------------| | `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the comment was created. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the comment was created. | | `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | +| `text` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example @@ -635,7 +639,7 @@ Contains a single plain text comment from either the buyer or seller. "author": NegotiableQuoteUser, "created_at": "abc123", "creator_type": "BUYER", - "text": "xyz789", + "text": "abc123", "uid": 4 } ``` @@ -667,12 +671,12 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | +| `comment` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The comment provided by the buyer. | #### Example ```json -{"comment": "abc123"} +{"comment": "xyz789"} ``` @@ -685,9 +689,9 @@ Contains custom log entries added by third-party extensions. | Field Name | Description | |------------|-------------| -| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | -| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | -| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | +| `new_value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The title of the custom log entry. | #### Example @@ -709,8 +713,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -761,12 +765,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "xyz789"} +{"comment": "abc123"} ``` @@ -782,8 +786,8 @@ Contains details about a change for a negotiable quote. | `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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -826,15 +830,15 @@ Contains a new expiration date and the previous date. | Field Name | Description | |------------|-------------| -| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | +| `new_expiration` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { "new_expiration": "xyz789", - "old_expiration": "abc123" + "old_expiration": "xyz789" } ``` @@ -848,7 +852,7 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -929,12 +933,12 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -947,13 +951,13 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -{"quantity": 987.65, "quote_item_uid": "4"} +{"quantity": 123.45, "quote_item_uid": 4} ``` @@ -966,15 +970,15 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | Payment method code | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { "code": "xyz789", - "purchase_order_number": "abc123" + "purchase_order_number": "xyz789" } ``` @@ -986,17 +990,17 @@ Defines the payment method to be applied to the negotiable quote. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/2-4-7/types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `selected_shipping_method` - [`SelectedShippingMethod`](/reference/graphql/2-4-7/types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's telephone number. | #### Example @@ -1011,8 +1015,8 @@ Defines the payment method to be applied to the negotiable quote. "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -1027,8 +1031,8 @@ Defines shipping addresses for the negotiable quote. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Text provided by the company user. | #### Example @@ -1036,7 +1040,7 @@ Defines shipping addresses for the negotiable quote. { "address": NegotiableQuoteAddressInput, "customer_address_uid": 4, - "customer_notes": "xyz789" + "customer_notes": "abc123" } ``` @@ -1050,7 +1054,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1113,20 +1117,20 @@ Contains details about a negotiable quote template. |------------|-------------| | `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!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `expiration_date` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/2-4-7/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](/reference/graphql/2-4-7/types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](/reference/graphql/2-4-7/types-c-e.md#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!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | +| `status` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The total number of items in the negotiable quote template. | #### Example @@ -1137,17 +1141,17 @@ Contains details about a negotiable quote template. "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": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "xyz789", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } ``` @@ -1161,8 +1165,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | +| `state` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1183,21 +1187,21 @@ Contains data for a negotiable quote template in a grid. | Field Name | Description | |------------|-------------| -| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | -| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | -| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | -| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | -| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `activated_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -1206,18 +1210,18 @@ Contains data for a negotiable quote template in a grid. "activated_at": "xyz789", "company_name": "xyz789", "expiration_date": "abc123", - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "last_shared_at": "xyz789", - "max_order_commitment": 123, - "min_negotiated_grand_total": 987.65, + "max_order_commitment": 987, + "min_negotiated_grand_total": 123.45, "min_order_commitment": 123, "name": "xyz789", "orders_placed": 123, "sales_rep_name": "xyz789", - "state": "abc123", + "state": "xyz789", "status": "xyz789", "submitted_by": "abc123", - "template_id": "4" + "template_id": 4 } ``` @@ -1231,15 +1235,20 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `item_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-f-i.md#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!`](/reference/graphql/2-4-7/types-f-i.md#float) | The new quantity of the negotiable quote item. | #### Example ```json -{"item_id": 4, "max_qty": 123.45, "min_qty": 987.65, "quantity": 123.45} +{ + "item_id": "4", + "max_qty": 123.45, + "min_qty": 987.65, + "quantity": 123.45 +} ``` @@ -1253,8 +1262,8 @@ Defines shipping addresses for the negotiable quote template. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Text provided by the company user. | #### Example @@ -1276,7 +1285,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1313,9 +1322,9 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-7/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1324,7 +1333,7 @@ Contains a list of negotiable templates that match the specified filter. "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } ``` @@ -1336,7 +1345,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1347,7 +1356,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -1360,7 +1369,7 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1378,15 +1387,15 @@ A limited view of a Buyer or Seller in the negotiable quote process. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The buyer's or seller's last name. | #### Example ```json { "firstname": "xyz789", - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -1401,9 +1410,9 @@ Contains a list of negotiable that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-7/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1426,13 +1435,13 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | -| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json -{"message": "xyz789", "uid": 4} +{"message": "abc123", "uid": 4} ``` @@ -1445,12 +1454,12 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -1463,15 +1472,15 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json { "order_id": "abc123", - "order_number": "xyz789" + "order_number": "abc123" } ``` @@ -1485,41 +1494,41 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | -| `fax` - [`String`](types-q-s.md#string) | The fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `city` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The city or town. | +| `company` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](/reference/graphql/2-4-7/types-c-e.md#countrycodeenum) | The customer's country. | +| `fax` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", "fax": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", "region": "xyz789", - "region_id": 4, + "region_id": "4", "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -1533,16 +1542,16 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | -| `number` - [`String!`](types-q-s.md#string) | Order number. | -| `postcode` - [`String!`](types-q-s.md#string) | Order billing address postcode. | +| `email` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Order billing address email. | +| `number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Order number. | +| `postcode` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Order billing address postcode. | #### Example ```json { "email": "abc123", - "number": "abc123", + "number": "xyz789", "postcode": "abc123" } ``` @@ -1555,26 +1564,26 @@ Input to retrieve an order based on details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | | `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the order item. | #### Example @@ -1585,21 +1594,21 @@ Input to retrieve an order based on details. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "xyz789", + "product_type": "abc123", "product_url_key": "xyz789", "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, + "quantity_invoiced": 123.45, "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -1613,34 +1622,34 @@ Order item details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | | `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | -| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | -| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | +| [`DownloadableOrderItem`](/reference/graphql/2-4-7/types-c-e.md#downloadableorderitem) | +| [`BundleOrderItem`](/reference/graphql/2-4-7/types-a-b.md#bundleorderitem) | +| [`GiftCardOrderItem`](/reference/graphql/2-4-7/types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1654,19 +1663,19 @@ Order item details. "gift_wrapping": GiftWrapping, "id": 4, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "xyz789", - "product_url_key": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_returned": 123.45, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -1680,8 +1689,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The name of the option. | -| `value` - [`String!`](types-q-s.md#string) | The value of the option. | +| `label` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The value of the option. | #### Example @@ -1703,16 +1712,16 @@ Contains details about the payment method used to pay for the order. | Field Name | Description | |------------|-------------| | `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | -| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example ```json { "additional_data": [KeyValue], - "name": "abc123", - "type": "abc123" + "name": "xyz789", + "type": "xyz789" } ``` @@ -1726,11 +1735,11 @@ Contains order shipment details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-7/types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](/reference/graphql/2-4-7/types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](/reference/graphql/2-4-7/types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example @@ -1739,7 +1748,7 @@ Contains order shipment details. "comments": [SalesCommentItem], "id": "4", "items": [ShipmentItemInterface], - "number": "abc123", + "number": "xyz789", "tracking": [ShipmentTracking] } ``` @@ -1754,12 +1763,12 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](types-q-s.md#string) | Order token. | +| `token` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Order token. | #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -1773,11 +1782,11 @@ Contains details about the sales total amounts used to calculate the final price | Field Name | Description | |------------|-------------| | `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | The applied discounts to the order. | | `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the order. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-t-z.md#taxitem) | The order tax details. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-7/types-t-z.md#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. | @@ -1808,15 +1817,15 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { "payer_id": "xyz789", - "token": "abc123" + "token": "xyz789" } ``` @@ -1830,15 +1839,15 @@ A set of relative URLs that PayPal uses in response to various actions during th | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](/reference/graphql/2-4-7/types-q-s.md#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!`](/reference/graphql/2-4-7/types-q-s.md#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", + "cancel_url": "xyz789", "error_url": "xyz789", "return_url": "abc123" } @@ -1874,9 +1883,9 @@ Contains information used to generate PayPal iframe for transaction. Applies to | Field Name | Description | |------------|-------------| | `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | +| `paypal_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example @@ -1899,12 +1908,12 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -1917,15 +1926,15 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | Input Field | Description | |-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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. | +| `cc_details` - [`CreditCardDetailsInput!`](/reference/graphql/2-4-7/types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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 + "is_active_payment_token_enabler": false } ``` @@ -1939,8 +1948,8 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The payload returned from PayPal. | #### Example @@ -1959,7 +1968,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -1977,7 +1986,7 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | | `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example @@ -1999,17 +2008,17 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](/reference/graphql/2-4-7/types-q-s.md#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!`](/reference/graphql/2-4-7/types-q-s.md#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": "abc123" + "error_url": "xyz789", + "return_url": "xyz789" } ``` @@ -2023,21 +2032,21 @@ Contains payment fields that are common to all types of payment methods. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-7/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | -| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | -| [`ApplePayConfig`](types-a-b.md#applepayconfig) | -| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | +| [`HostedFieldsConfig`](/reference/graphql/2-4-7/types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](/reference/graphql/2-4-7/types-q-s.md#smartbuttonsconfig) | +| [`ApplePayConfig`](/reference/graphql/2-4-7/types-a-b.md#applepayconfig) | +| [`GooglePayConfig`](/reference/graphql/2-4-7/types-f-i.md#googlepayconfig) | #### Example @@ -2047,7 +2056,7 @@ Contains payment fields that are common to all types of payment methods. "is_visible": true, "payment_intent": "abc123", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "title": "xyz789" } ``` @@ -2062,10 +2071,10 @@ Retrieves the payment configuration for a given location | Field Name | Description | |------------|-------------| -| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | -| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | +| `apple_pay` - [`ApplePayConfig`](/reference/graphql/2-4-7/types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `google_pay` - [`GooglePayConfig`](/reference/graphql/2-4-7/types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](/reference/graphql/2-4-7/types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](/reference/graphql/2-4-7/types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2110,27 +2119,27 @@ Defines the payment method. | Input Field | Description | |-------------|-------------| -| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_ach_direct_debit` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_applepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | -| `braintree_googlepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_paypal` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_paypal_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](types-f-i.md#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `braintree` - [`BraintreeInput`](/reference/graphql/2-4-7/types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](/reference/graphql/2-4-7/types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-7/types-a-b.md#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-7/types-a-b.md#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](/reference/graphql/2-4-7/types-a-b.md#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-7/types-a-b.md#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](/reference/graphql/2-4-7/types-a-b.md#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-7/types-a-b.md#braintreevaultinput) | | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](/reference/graphql/2-4-7/types-f-i.md#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`](types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#vaultmethodinput) | Required input for vault | +| `payflowpro_cc_vault` - [`VaultTokenInput`](/reference/graphql/2-4-7/types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](/reference/graphql/2-4-7/types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](/reference/graphql/2-4-7/types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](/reference/graphql/2-4-7/types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](/reference/graphql/2-4-7/types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](/reference/graphql/2-4-7/types-t-z.md#vaultmethodinput) | Required input for vault | | `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `purchase_order_number` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -2144,7 +2153,7 @@ Defines the payment method. "braintree_googlepay_vault": BraintreeVaultInput, "braintree_paypal": BraintreeInput, "braintree_paypal_vault": BraintreeVaultInput, - "code": "xyz789", + "code": "abc123", "hosted_pro": HostedProInput, "payflow_express": PayflowExpressInput, "payflow_link": PayflowLinkInput, @@ -2170,10 +2179,10 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The order ID generated by Payment Services | | `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `status` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The status of the payment order | #### Example @@ -2194,14 +2203,14 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](/reference/graphql/2-4-7/types-q-s.md#sdkparams) | The payment SDK parameters | #### Example ```json { - "code": "abc123", + "code": "xyz789", "params": [SDKParams] } ``` @@ -2214,7 +2223,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | +| `card` - [`Card`](/reference/graphql/2-4-7/types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2232,9 +2241,9 @@ The stored payment method available to the customer. | Field Name | Description | |------------|-------------| -| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | +| `details` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example @@ -2243,7 +2252,7 @@ The stored payment method available to the customer. { "details": "xyz789", "payment_method_code": "xyz789", - "public_hash": "xyz789", + "public_hash": "abc123", "type": "card" } ``` @@ -2277,15 +2286,15 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { - "payer_id": "xyz789", - "token": "xyz789" + "payer_id": "abc123", + "token": "abc123" } ``` @@ -2299,21 +2308,21 @@ Defines the attributes required to receive a payment token for Express Checkout | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | -| `express_button` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | +| `use_paypal_credit` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { - "cart_id": "abc123", - "code": "abc123", - "express_button": true, + "cart_id": "xyz789", + "code": "xyz789", + "express_button": false, "urls": PaypalExpressUrlsInput, - "use_paypal_credit": true + "use_paypal_credit": false } ``` @@ -2328,14 +2337,14 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | Field Name | Description | |------------|-------------| | `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | +| `token` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The token returned by PayPal. | #### Example ```json { "paypal_urls": PaypalExpressUrlList, - "token": "abc123" + "token": "xyz789" } ``` @@ -2349,15 +2358,15 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | Field Name | Description | |------------|-------------| -| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | +| `edit` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL to the PayPal login page. | #### Example ```json { - "edit": "abc123", - "start": "xyz789" + "edit": "xyz789", + "start": "abc123" } ``` @@ -2371,10 +2380,10 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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`](/reference/graphql/2-4-7/types-q-s.md#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!`](/reference/graphql/2-4-7/types-q-s.md#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`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -2397,22 +2406,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Possible Types | PhysicalProductInterface Types | |----------------| -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-7/types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-7/types-c-e.md#configurableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-7/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-7/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-7/types-f-i.md#groupedproduct) | #### Example ```json -{"weight": 123.45} +{"weight": 987.65} ``` @@ -2425,36 +2434,36 @@ Defines Pickup Location information. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | | -| `contact_name` - [`String`](types-q-s.md#string) | | -| `country_id` - [`String`](types-q-s.md#string) | | -| `description` - [`String`](types-q-s.md#string) | | -| `email` - [`String`](types-q-s.md#string) | | -| `fax` - [`String`](types-q-s.md#string) | | -| `latitude` - [`Float`](types-f-i.md#float) | | -| `longitude` - [`Float`](types-f-i.md#float) | | -| `name` - [`String`](types-q-s.md#string) | | -| `phone` - [`String`](types-q-s.md#string) | | -| `pickup_location_code` - [`String`](types-q-s.md#string) | | -| `postcode` - [`String`](types-q-s.md#string) | | -| `region` - [`String`](types-q-s.md#string) | | -| `region_id` - [`Int`](types-f-i.md#int) | | -| `street` - [`String`](types-q-s.md#string) | | +| `city` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `contact_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `country_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `email` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `fax` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `latitude` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | | +| `longitude` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `phone` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `pickup_location_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `postcode` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `region` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | +| `region_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | | +| `street` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | | #### Example ```json { - "city": "xyz789", - "contact_name": "abc123", - "country_id": "abc123", + "city": "abc123", + "contact_name": "xyz789", + "country_id": "xyz789", "description": "abc123", "email": "abc123", "fax": "abc123", "latitude": 987.65, "longitude": 987.65, "name": "xyz789", - "phone": "abc123", + "phone": "xyz789", "pickup_location_code": "xyz789", "postcode": "xyz789", "region": "abc123", @@ -2473,14 +2482,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | Input Field | Description | |-------------|-------------| -| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | +| `city` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2507,22 +2516,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | Input Field | Description | |-------------|-------------| -| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | -| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | +| `city` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#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`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2558,8 +2567,8 @@ Top level object returned in a pickup locations search. | Field Name | Description | |------------|-------------| | `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of products returned. | #### Example @@ -2581,12 +2590,12 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -2618,7 +2627,7 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message. | #### Example @@ -2659,7 +2668,7 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a purchase order. | #### Example @@ -2677,7 +2686,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](/reference/graphql/2-4-7/types-c-e.md#customerorder) | Placed order. | #### Example @@ -2695,7 +2704,7 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2715,7 +2724,7 @@ Contains the results of the request to place an order. |------------|-------------| | `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | | `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | -| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | +| `orderV2` - [`CustomerOrder`](/reference/graphql/2-4-7/types-c-e.md#customerorder) | Full order information. | #### Example @@ -2737,12 +2746,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -2858,15 +2867,15 @@ Can be used to retrieve the main price details in case of bundle product | Field Name | Description | |------------|-------------| -| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | +| `discount_percentage` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The regular price of the main product | #### Example ```json { - "discount_percentage": 123.45, + "discount_percentage": 987.65, "main_final_price": 987.65, "main_price": 987.65 } @@ -2943,14 +2952,14 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | +| `code` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The display value of the attribute. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "value": "xyz789" } ``` @@ -2965,15 +2974,15 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `category_url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | -| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | -| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | -| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | -| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | +| `category_id` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | +| `description` - [`FilterMatchTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `price` - [`FilterRangeTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `short_description` - [`FilterMatchTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `sku` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -3001,10 +3010,10 @@ Specifies the attribute to use for sorting search results and indicates whether | Input Field | Description | |-------------|-------------| -| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | +| `name` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](/reference/graphql/2-4-7/types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -3022,8 +3031,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](/reference/graphql/2-4-7/types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3044,13 +3053,13 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | -| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The discount expressed a percentage. | #### Example ```json -{"amount_off": 123.45, "percent_off": 123.45} +{"amount_off": 123.45, "percent_off": 987.65} ``` @@ -3063,45 +3072,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | Input Field | Description | |-------------|-------------| -| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `category_id` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | +| `price` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -3159,10 +3168,10 @@ Contains product image information, including the image URL and label. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL of the product image or video. | #### Example @@ -3170,8 +3179,8 @@ Contains product image information, including the image URL and label. { "disabled": true, "label": "abc123", - "position": 987, - "url": "abc123" + "position": 123, + "url": "xyz789" } ``` @@ -3185,7 +3194,7 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | +| `sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | Product SKU. | #### Example @@ -3203,87 +3212,87 @@ Contains fields that are common to all types of products. | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](/reference/graphql/2-4-7/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `is_returnable` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-7/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `review_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The total count of all the reviews given to the product. | | `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `special_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | | `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `swatch_image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of a swatch image. | | `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `type_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-7/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-7/types-t-z.md#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`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`VirtualProduct`](/reference/graphql/2-4-7/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-7/types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-7/types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](/reference/graphql/2-4-7/types-c-e.md#downloadableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-7/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-7/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-7/types-f-i.md#groupedproduct) | #### Example ```json { - "attribute_set_id": 123, - "canonical_url": "xyz789", + "attribute_set_id": 987, + "canonical_url": "abc123", "categories": [CategoryInterface], - "color": 123, + "color": 987, "country_of_manufacture": "abc123", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": "abc123", - "id": 123, + "id": 987, "image": ProductImage, "is_returnable": "xyz789", "manufacturer": 123, @@ -3291,12 +3300,12 @@ Contains fields that are common to all types of products. "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "new_from_date": "xyz789", + "meta_title": "abc123", + "name": "abc123", + "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options_container": "abc123", + "only_x_left_in_stock": 987.65, + "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -3306,25 +3315,25 @@ Contains fields that are common to all types of products. "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 123.45, "special_to_date": "abc123", - "staged": false, + "staged": true, "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], - "type_id": "xyz789", + "type_id": "abc123", "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -3339,21 +3348,21 @@ An implementation of `ProductLinksInterface`. | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { - "link_type": "xyz789", + "link_type": "abc123", "linked_product_sku": "xyz789", - "linked_product_type": "abc123", - "position": 123, - "sku": "xyz789" + "linked_product_type": "xyz789", + "position": 987, + "sku": "abc123" } ``` @@ -3367,11 +3376,11 @@ Contains information about linked products, including the link type and product | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3384,9 +3393,9 @@ Contains information about linked products, including the link type and product ```json { "link_type": "abc123", - "linked_product_sku": "abc123", - "linked_product_type": "abc123", - "position": 123, + "linked_product_sku": "xyz789", + "linked_product_type": "xyz789", + "position": 987, "sku": "xyz789" } ``` @@ -3401,16 +3410,16 @@ Contains an image in base64 format and basic information about the image. | Field Name | Description | |------------|-------------| -| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | -| `name` - [`String`](types-q-s.md#string) | The file name of the image. | -| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | +| `base64_encoded_data` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "base64_encoded_data": "xyz789", - "name": "abc123", + "base64_encoded_data": "abc123", + "name": "xyz789", "type": "abc123" } ``` @@ -3425,21 +3434,21 @@ Contains a link to a video file and basic information about the video. | Field Name | Description | |------------|-------------| -| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | -| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | -| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | -| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | -| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | -| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | +| `media_type` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL to the video. | #### Example ```json { - "media_type": "xyz789", + "media_type": "abc123", "video_description": "abc123", - "video_metadata": "xyz789", - "video_provider": "abc123", + "video_metadata": "abc123", + "video_provider": "xyz789", "video_title": "xyz789", "video_url": "xyz789" } @@ -3457,7 +3466,7 @@ Represents a product price. |------------|-------------| | `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]`](types-f-i.md#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -3505,25 +3514,25 @@ Contains details of a product review. | Field Name | Description | |------------|-------------| -| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `average_rating` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `summary` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The review text. | #### Example ```json { "average_rating": 123.45, - "created_at": "xyz789", - "nickname": "xyz789", + "created_at": "abc123", + "nickname": "abc123", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], - "summary": "xyz789", - "text": "xyz789" + "summary": "abc123", + "text": "abc123" } ``` @@ -3537,8 +3546,8 @@ Contains data about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example @@ -3559,8 +3568,8 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | An encoded rating value ID. | #### Example @@ -3581,16 +3590,16 @@ Contains details about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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", + "id": "abc123", + "name": "abc123", "values": [ProductReviewRatingValueMetadata] } ``` @@ -3605,15 +3614,15 @@ Contains details about a single value in a product review. | Field Name | Description | |------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `value` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { "value": "xyz789", - "value_id": "xyz789" + "value_id": "abc123" } ``` @@ -3646,7 +3655,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -3686,21 +3695,21 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | Field Name | Description | |------------|-------------| -| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | +| `customer_group_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json { - "customer_group_id": "xyz789", + "customer_group_id": "abc123", "percentage_value": 123.45, - "qty": 123.45, + "qty": 987.65, "value": 123.45, - "website_id": 123.45 + "website_id": 987.65 } ``` @@ -3714,20 +3723,20 @@ Contains information about a product video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json { - "disabled": false, - "label": "xyz789", + "disabled": true, + "label": "abc123", "position": 123, - "url": "xyz789", + "url": "abc123", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -3742,13 +3751,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](types-a-b.md#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](/reference/graphql/2-4-7/types-a-b.md#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`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-7/types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](/reference/graphql/2-4-7/types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -3760,7 +3769,7 @@ Contains the results of a `products` query. "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 123 + "total_count": 987 } ``` @@ -3777,15 +3786,15 @@ Contains details about a purchase order. | `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!`](types-q-s.md#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](types-c-e.md#customer) | The company user who created the purchase order. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](/reference/graphql/2-4-7/types-c-e.md#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!`](types-q-s.md#string) | The purchase order number. | -| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](types-c-e.md#cart) | The quote related to the purchase order. | +| `number` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](/reference/graphql/2-4-7/types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](/reference/graphql/2-4-7/types-c-e.md#cart) | The quote related to the purchase order. | | `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -3794,15 +3803,15 @@ Contains details about a purchase order. "approval_flow": [PurchaseOrderRuleApprovalFlow], "available_actions": ["REJECT"], "comments": [PurchaseOrderComment], - "created_at": "abc123", + "created_at": "xyz789", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], "number": "xyz789", "order": CustomerOrder, "quote": Cart, "status": "PENDING", - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } ``` @@ -3836,7 +3845,7 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example @@ -3855,18 +3864,18 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | A formatted message. | -| `name` - [`String`](types-q-s.md#string) | The approver name. | -| `role` - [`String`](types-q-s.md#string) | The approver role. | +| `message` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A formatted message. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The approver name. | +| `role` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The approver role. | | `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { - "message": "xyz789", - "name": "abc123", + "message": "abc123", + "name": "xyz789", "role": "abc123", "status": "PENDING", "updated_at": "xyz789" @@ -3901,16 +3910,16 @@ Contains details about a purchase order approval rule. | Field Name | Description | |------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `applies_to_roles` - [`[CompanyRole]!`](/reference/graphql/2-4-7/types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](/reference/graphql/2-4-7/types-c-e.md#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!`](types-q-s.md#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The name of the purchase order approval rule. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the purchase order approval rule. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -3921,11 +3930,11 @@ Contains details about a purchase order approval rule. "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "xyz789", "created_by": "xyz789", - "description": "xyz789", - "name": "abc123", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } ``` @@ -4010,12 +4019,12 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | +| `quantity` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} ``` @@ -4028,22 +4037,22 @@ Defines a new purchase order approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | +| `applies_to` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#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]!`](/reference/graphql/2-4-7/types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](/reference/graphql/2-4-7/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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], + "applies_to": [4], + "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", - "name": "abc123", + "description": "xyz789", + "name": "xyz789", "status": "ENABLED" } ``` @@ -4058,9 +4067,9 @@ Contains metadata that can be used to render rule edit forms. | Field Name | Description | |------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | +| `available_applies_to` - [`[CompanyRole]!`](/reference/graphql/2-4-7/types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](/reference/graphql/2-4-7/types-a-b.md#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]!`](/reference/graphql/2-4-7/types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4118,8 +4127,8 @@ Contains the approval rules that the customer can see. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4141,18 +4150,18 @@ Contains details about a comment. | Field Name | Description | |------------|-------------| -| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | -| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | +| `author` - [`Customer`](/reference/graphql/2-4-7/types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | A unique identifier of the comment. | #### Example ```json { "author": Customer, - "created_at": "xyz789", - "text": "abc123", + "created_at": "abc123", + "text": "xyz789", "uid": "4" } ``` @@ -4187,10 +4196,10 @@ Contains details about a status change. | Field Name | Description | |------------|-------------| -| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | -| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | +| `activity` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example @@ -4198,8 +4207,8 @@ Contains details about a status change. { "activity": "xyz789", "created_at": "abc123", - "message": "xyz789", - "uid": 4 + "message": "abc123", + "uid": "4" } ``` @@ -4214,14 +4223,14 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | +| `rule_name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the applied rule. | #### Example ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "xyz789" + "rule_name": "abc123" } ``` @@ -4260,8 +4269,8 @@ Contains a list of purchase orders. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4283,7 +4292,7 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of purchase order UIDs. | #### Example @@ -4323,9 +4332,9 @@ Defines the criteria to use to filter the list of purchase orders. | Input Field | Description | |-------------|-------------| -| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `company_purchase_orders` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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 @@ -4334,7 +4343,7 @@ Defines the criteria to use to filter the list of purchase orders. { "company_purchase_orders": true, "created_date": FilterRangeTypeInput, - "require_my_approval": false, + "require_my_approval": true, "status": "PENDING" } ``` 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 index 118ffc47f..b9805eff5 100644 --- 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 @@ -27,9 +27,9 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `item_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | | `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `templateId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -59,7 +59,7 @@ Contains a notification message for a negotiable quote template. ```json { "message": "abc123", - "type": "xyz789" + "type": "abc123" } ``` @@ -76,9 +76,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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!`](types-a-b.md#boolean) | Return whether recaptcha is enabled or not | +| `is_enabled` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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!`](types-f-i.md#float) | The minimum score that identifies a user interaction as a potential risk. | +| `minimum_score` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -86,12 +86,12 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { "badge_position": "xyz789", - "failure_message": "xyz789", + "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "abc123", - "minimum_score": 987.65, - "website_key": "xyz789" + "is_enabled": false, + "language_code": "xyz789", + "minimum_score": 123.45, + "website_key": "abc123" } ``` @@ -129,16 +129,16 @@ Contains reCAPTCHA V3-Invisible configuration details. | Field Name | Description | |------------|-------------| | `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "id": 123, - "name": "xyz789" + "name": "abc123" } ``` @@ -157,7 +157,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -170,7 +170,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -232,7 +232,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -250,7 +250,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -268,7 +268,7 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example @@ -286,7 +286,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -305,15 +305,15 @@ Specifies which items to remove from the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { - "cart_id": "xyz789", - "cart_item_id": 987, + "cart_id": "abc123", + "cart_item_id": 123, "cart_item_uid": 4 } ``` @@ -328,7 +328,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -346,13 +346,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_item_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_item_uids": [4], "quote_uid": 4} +{"quote_item_uids": ["4"], "quote_uid": 4} ``` @@ -365,7 +365,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -383,8 +383,8 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `item_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -402,16 +402,13 @@ Defines which products to remove from a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{ - "products": ["4"], - "uid": "4" -} +{"products": ["4"], "uid": 4} ``` @@ -424,8 +421,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-7/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-7/types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -446,12 +443,12 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example ```json -{"return_shipping_tracking_uid": "4"} +{"return_shipping_tracking_uid": 4} ``` @@ -482,7 +479,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -518,7 +515,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -538,13 +535,13 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example ```json { - "quote_comment": "abc123", + "quote_comment": "xyz789", "quote_name": "xyz789", "quote_uid": "4" } @@ -560,7 +557,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -578,8 +575,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](/reference/graphql/2-4-7/types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -600,9 +597,9 @@ Defines properties of a negotiable quote request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](types-a-b.md#boolean) | Flag indicating if quote is draft or not. | +| `cart_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Flag indicating if quote is draft or not. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -611,8 +608,8 @@ Defines properties of a negotiable quote request. { "cart_id": "4", "comment": NegotiableQuoteCommentInput, - "is_draft": false, - "quote_name": "xyz789" + "is_draft": true, + "quote_name": "abc123" } ``` @@ -626,7 +623,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -644,7 +641,7 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example @@ -665,16 +662,16 @@ Contains information needed to start a return request. | `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!`](types-f-i.md#id) | The unique ID for a `Order` object. | +| `order_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { - "comment_text": "abc123", + "comment_text": "xyz789", "contact_email": "xyz789", "items": [RequestReturnItemInput], - "order_uid": "4" + "order_uid": 4 } ``` @@ -688,9 +685,9 @@ Contains details about an item to be returned. | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](types-f-i.md#float) | The quantity of the item to be returned. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](/reference/graphql/2-4-7/types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -700,8 +697,8 @@ Contains details about an item to be returned. "entered_custom_attributes": [ EnteredCustomAttributeInput ], - "order_item_uid": "4", - "quantity_to_return": 123.45, + "order_item_uid": 4, + "quantity_to_return": 987.65, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -742,21 +739,21 @@ Defines the contents of a requisition list. |------------|-------------| | `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!`](types-f-i.md#int) | The number of items in the list. | +| `items_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "items": RequistionListItems, "items_count": 987, "name": "abc123", - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } ``` @@ -770,8 +767,8 @@ Defines requisition list filters. | Input Field | Description | |-------------|-------------| -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-7/types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -793,20 +790,20 @@ The interface for requisition list items. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for the requisition list item. | #### Possible Types | RequisitionListItemInterface Types | |----------------| | [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | +| [`VirtualRequisitionListItem`](/reference/graphql/2-4-7/types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](/reference/graphql/2-4-7/types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](/reference/graphql/2-4-7/types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](/reference/graphql/2-4-7/types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](/reference/graphql/2-4-7/types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -814,7 +811,7 @@ The interface for requisition list items. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -829,9 +826,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-7/types-c-e.md#enteredoptioninput) | Entered option IDs. | | `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -840,10 +837,10 @@ Defines the items to add. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["abc123"], - "sku": "xyz789" + "parent_sku": "abc123", + "quantity": 987.65, + "selected_options": ["xyz789"], + "sku": "abc123" } ``` @@ -859,7 +856,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -867,7 +864,7 @@ Defines customer requisition lists. { "items": [RequisitionList], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -883,7 +880,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | +| `total_pages` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of pages returned. | #### Example @@ -911,10 +908,10 @@ Contains details about a return. | `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`](types-c-e.md#customerorder) | The order associated with the return. | +| `order` - [`CustomerOrder`](/reference/graphql/2-4-7/types-c-e.md#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!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -922,14 +919,14 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "xyz789", + "created_at": "abc123", "customer": ReturnCustomer, "items": [ReturnItem], "number": "abc123", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -946,14 +943,14 @@ Contains details about a return comment. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example ```json { "author_name": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "text": "abc123", "uid": "4" } @@ -970,7 +967,7 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example @@ -979,7 +976,7 @@ Contains details about a `ReturnCustomerAttribute` object. { "label": "xyz789", "uid": 4, - "value": "xyz789" + "value": "abc123" } ``` @@ -1003,7 +1000,7 @@ The customer information for the return. { "email": "xyz789", "firstname": "abc123", - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -1018,12 +1015,12 @@ Contains details about a product being returned. | 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]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item requested to be returned. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](/reference/graphql/2-4-7/types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of the item requested to be returned. | | `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1032,7 +1029,7 @@ Contains details about a product being returned. "custom_attributes": [ReturnCustomAttribute], "custom_attributesV2": [AttributeValueInterface], "order_item": OrderItemInterface, - "quantity": 123.45, + "quantity": 987.65, "request_quantity": 123.45, "status": "PENDING", "uid": "4" @@ -1049,36 +1046,36 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-7/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | | `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-7/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/2-4-7/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether the attribute value must be unique. | | `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `multiline_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/2-4-7/types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/2-4-7/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { - "code": "4", + "code": 4, "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", "is_required": true, "is_unique": true, - "label": "abc123", + "label": "xyz789", "multiline_count": 987, "options": [CustomAttributeOptionInterface], - "sort_order": 987, + "sort_order": 123, "validate_rules": [ValidationRule] } ``` @@ -1138,7 +1135,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `city` - [`String!`](#string) | The city for product returns. | | `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](types-c-e.md#country) | An object that defines the country for product returns. | +| `country` - [`Country!`](/reference/graphql/2-4-7/types-c-e.md#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. | @@ -1148,13 +1145,13 @@ Contains details about the shipping address used for receiving returned items. ```json { - "city": "xyz789", - "contact_name": "abc123", + "city": "abc123", + "contact_name": "xyz789", "country": Country, "postcode": "abc123", "region": Region, "street": ["xyz789"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1169,13 +1166,13 @@ Contains details about the carrier on a return. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example ```json { - "label": "abc123", + "label": "xyz789", "uid": "4" } ``` @@ -1193,7 +1190,7 @@ Contains shipping and tracking details. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1201,7 +1198,7 @@ Contains shipping and tracking details. { "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, - "tracking_number": "abc123", + "tracking_number": "xyz789", "uid": "4" } ``` @@ -1222,7 +1219,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "xyz789", "type": "INFORMATION"} +{"text": "abc123", "type": "INFORMATION"} ``` @@ -1281,7 +1278,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | +| `total_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The total number of return requests. | #### Example @@ -1289,7 +1286,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1303,7 +1300,7 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example @@ -1345,13 +1342,13 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | -| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | +| `money` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The reward points amount in points. | #### Example ```json -{"money": Money, "points": 987.65} +{"money": Money, "points": 123.45} ``` @@ -1367,7 +1364,7 @@ Contain details about the reward points transaction. | `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!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | +| `points_change` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example @@ -1376,7 +1373,7 @@ Contain details about the reward points transaction. "balance": RewardPointsAmount, "change_reason": "abc123", "date": "xyz789", - "points_change": 987.65 + "points_change": 123.45 } ``` @@ -1412,13 +1409,13 @@ Contains details about customer's reward points rate. | Field Name | Description | |------------|-------------| -| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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. | +| `currency_amount` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#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!`](/reference/graphql/2-4-7/types-f-i.md#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} +{"currency_amount": 987.65, "points": 123.45} ``` @@ -1470,30 +1467,30 @@ Routable entities serve as the model for a rendered page. | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](types-c-e.md#cmspage) | -| [`CategoryTree`](types-c-e.md#categorytree) | -| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`CmsPage`](/reference/graphql/2-4-7/types-c-e.md#cmspage) | +| [`CategoryTree`](/reference/graphql/2-4-7/types-c-e.md#categorytree) | +| [`VirtualProduct`](/reference/graphql/2-4-7/types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-7/types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](/reference/graphql/2-4-7/types-c-e.md#downloadableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-7/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-7/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-7/types-f-i.md#groupedproduct) | | [`RoutableUrl`](#routableurl) | #### Example ```json { - "redirect_code": 987, + "redirect_code": 123, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -1509,9 +1506,9 @@ Default implementation of RoutableInterface. This type is returned when the URL | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example @@ -1540,7 +1537,7 @@ Defines the name and value of a SDK parameter ```json { - "name": "abc123", + "name": "xyz789", "value": "xyz789" } ``` @@ -1563,7 +1560,7 @@ Contains details about a comment. ```json { "message": "abc123", - "timestamp": "xyz789" + "timestamp": "abc123" } ``` @@ -1597,14 +1594,14 @@ Provides navigation for the query response. | Field Name | Description | |------------|-------------| -| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | -| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | +| `current_page` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 123, "page_size": 123, "total_pages": 123} +{"current_page": 123, "page_size": 987, "total_pages": 987} ``` @@ -1622,7 +1619,7 @@ A string that contains search suggestion #### Example ```json -{"search": "xyz789"} +{"search": "abc123"} ``` @@ -1635,19 +1632,19 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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": "abc123", + "id": 987, + "label": "abc123", + "type": "xyz789", "uid": 4, "values": [SelectedBundleOptionValue] } @@ -1663,21 +1660,21 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | Use `uid` instead | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | Use `uid` instead | | `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `price` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { "id": 123, - "label": "abc123", + "label": "xyz789", "price": 987.65, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -1691,11 +1688,11 @@ Contains details about a selected configurable option. | Field Name | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `configurable_product_option_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | | `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | | `value_label` - [`String!`](#string) | The display name of the selected configurable option. | #### Example @@ -1703,11 +1700,11 @@ Contains details about a selected configurable option. ```json { "configurable_product_option_uid": "4", - "configurable_product_option_value_uid": 4, - "id": 987, - "option_label": "xyz789", - "value_id": 123, - "value_label": "abc123" + "configurable_product_option_value_uid": "4", + "id": 123, + "option_label": "abc123", + "value_id": 987, + "value_label": "xyz789" } ``` @@ -1722,15 +1719,12 @@ Contains details about an attribute the buyer selected. | Input Field | Description | |-------------|-------------| | `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | -| `value` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | +| `value` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | #### Example ```json -{ - "attribute_code": "abc123", - "value": "4" -} +{"attribute_code": "xyz789", "value": 4} ``` @@ -1743,11 +1737,11 @@ Identifies a customized product that has been placed in a cart. | Field Name | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customizable option is required. | +| `customizable_option_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the customizable option is required. | | `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](types-f-i.md#int) | A value indicating the order to display this option. | +| `sort_order` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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. | @@ -1755,12 +1749,12 @@ Identifies a customized product that has been placed in a cart. ```json { - "customizable_option_uid": 4, - "id": 123, + "customizable_option_uid": "4", + "id": 987, "is_required": true, - "label": "xyz789", - "sort_order": 987, - "type": "xyz789", + "label": "abc123", + "sort_order": 123, + "type": "abc123", "values": [SelectedCustomizableOptionValue] } ``` @@ -1775,10 +1769,10 @@ Identifies the value of the selected customized option. | Field Name | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `customizable_option_value_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | | `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](/reference/graphql/2-4-7/types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | | `value` - [`String!`](#string) | The text identifying the selected value. | #### Example @@ -1786,10 +1780,10 @@ Identifies the value of the selected customized option. ```json { "customizable_option_value_uid": 4, - "id": 987, - "label": "abc123", + "id": 123, + "label": "xyz789", "price": CartItemSelectedOptionValuePrice, - "value": "xyz789" + "value": "abc123" } ``` @@ -1812,8 +1806,8 @@ Describes the payment method the shopper selected. ```json { "code": "xyz789", - "purchase_order_number": "xyz789", - "title": "xyz789" + "purchase_order_number": "abc123", + "title": "abc123" } ``` @@ -1827,14 +1821,14 @@ Contains details about the selected shipping method and carrier. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#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!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `price_excl_tax` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1842,10 +1836,10 @@ Contains details about the selected shipping method and carrier. { "amount": Money, "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "abc123", + "carrier_code": "xyz789", + "carrier_title": "xyz789", "method_code": "abc123", - "method_title": "abc123", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1861,7 +1855,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](types-f-i.md#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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. | @@ -1915,7 +1909,7 @@ An output object that contains information about the recipient. ```json { "email": "abc123", - "name": "abc123" + "name": "xyz789" } ``` @@ -1937,7 +1931,7 @@ Contains details about a recipient. ```json { "email": "abc123", - "name": "xyz789" + "name": "abc123" } ``` @@ -1959,8 +1953,8 @@ An output object that contains information about the sender. ```json { - "email": "abc123", - "message": "abc123", + "email": "xyz789", + "message": "xyz789", "name": "abc123" } ``` @@ -1983,8 +1977,8 @@ Contains details about the sender. ```json { - "email": "xyz789", - "message": "abc123", + "email": "abc123", + "message": "xyz789", "name": "abc123" } ``` @@ -1999,13 +1993,13 @@ Contains details about the configuration of the Email to a Friend feature. | Field Name | Description | |------------|-------------| -| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | +| `enabled_for_customers` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": true, "enabled_for_guests": true} +{"enabled_for_customers": false, "enabled_for_guests": true} ``` @@ -2018,13 +2012,16 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} +{ + "comment": NegotiableQuoteCommentInput, + "quote_uid": "4" +} ``` @@ -2037,7 +2034,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2055,7 +2052,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](/reference/graphql/2-4-7/types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2063,7 +2060,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "xyz789" + "cart_id": "abc123" } ``` @@ -2077,7 +2074,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2096,19 +2093,19 @@ Defines the gift options applied to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/2-4-7/types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_message": GiftMessageInput, "gift_receipt_included": false, - "gift_wrapping_id": 4, + "gift_wrapping_id": "4", "printed_card_included": false } ``` @@ -2123,7 +2120,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The modified cart object. | #### Example @@ -2148,8 +2145,8 @@ Defines the guest email and cart. ```json { - "cart_id": "abc123", - "email": "xyz789" + "cart_id": "xyz789", + "email": "abc123" } ``` @@ -2163,7 +2160,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2181,7 +2178,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2199,15 +2196,15 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2221,7 +2218,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2239,15 +2236,15 @@ Defines the payment method of the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -2261,7 +2258,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2279,16 +2276,16 @@ Defines the shipping address to assign to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| `customer_address_id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](/reference/graphql/2-4-7/types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "customer_address_id": 4, - "quote_uid": "4", + "customer_address_id": "4", + "quote_uid": 4, "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2305,7 +2302,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2323,14 +2320,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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, + "quote_uid": "4", "shipping_methods": [ShippingMethodInput] } ``` @@ -2345,7 +2342,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2363,8 +2360,8 @@ Defines the shipping address to assign to the negotiable quote template. | Input Field | Description | |-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2386,7 +2383,7 @@ Applies a payment method to the quote. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/2-4-7/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2408,13 +2405,13 @@ Applies a payment method to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/2-4-7/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "payment_method": PaymentMethodInput } ``` @@ -2429,7 +2426,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2454,7 +2451,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2469,7 +2466,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2509,7 +2506,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2549,12 +2546,12 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example ```json -{"is_shared": true} +{"is_shared": false} ``` @@ -2574,7 +2571,7 @@ Defines the sender of an invitation to view a gift registry. ```json { - "message": "xyz789", + "message": "abc123", "name": "xyz789" } ``` @@ -2606,18 +2603,18 @@ Defines whether bundle items must be shipped together. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of shipped items. | #### Example ```json { - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -2636,31 +2633,31 @@ Order shipment item details. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-7/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | -| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | +| [`BundleShipmentItem`](/reference/graphql/2-4-7/types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](/reference/graphql/2-4-7/types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example ```json { - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 987.65 + "quantity_shipped": 123.45 } ``` @@ -2682,7 +2679,7 @@ Contains order shipment tracking details. ```json { - "carrier": "abc123", + "carrier": "xyz789", "number": "xyz789", "title": "xyz789" } @@ -2698,8 +2695,8 @@ Defines a single shipping address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `address` - [`CartAddressInput`](/reference/graphql/2-4-7/types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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. | @@ -2708,7 +2705,7 @@ Defines a single shipping address. ```json { "address": CartAddressInput, - "customer_address_id": 123, + "customer_address_id": 987, "customer_notes": "abc123", "pickup_location_code": "xyz789" } @@ -2724,23 +2721,23 @@ Contains shipping addresses and methods. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | An array that lists the items in the cart. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/2-4-7/types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](/reference/graphql/2-4-7/types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](/reference/graphql/2-4-7/types-c-e.md#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!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/2-4-7/types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `items_weight` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `region` - [`CartAddressRegion`](/reference/graphql/2-4-7/types-c-e.md#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. | @@ -2756,23 +2753,23 @@ Contains shipping addresses and methods. "cart_items": [CartItemQuantity], "cart_items_v2": [CartItemInterface], "city": "abc123", - "company": "xyz789", + "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_notes": "abc123", + "customer_notes": "xyz789", "fax": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "items_weight": 123.45, "lastname": "xyz789", - "middlename": "xyz789", - "pickup_location_code": "abc123", - "postcode": "xyz789", + "middlename": "abc123", + "pickup_location_code": "xyz789", + "postcode": "abc123", "prefix": "xyz789", "region": CartAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", - "telephone": "xyz789", + "telephone": "abc123", "uid": "abc123", "vat_id": "abc123" } @@ -2788,7 +2785,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of the discount. | #### Example @@ -2806,11 +2803,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](types-k-p.md#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The shipping amount, including tax. | | `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-7/types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The total amount for shipping. | #### Example @@ -2841,7 +2838,7 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "xyz789", + "carrier_code": "abc123", "method_code": "xyz789" } ``` @@ -2856,22 +2853,22 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-7/types-f-i.md#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]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-7/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-7/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-7/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | | `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-7/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2883,15 +2880,15 @@ An implementation for simple product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", + "id": "xyz789", "is_available": false, "max_qty": 987.65, - "min_qty": 987.65, + "min_qty": 123.45, "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -2906,70 +2903,70 @@ Defines a simple product, which is tangible and is usually sold in single units | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `categories` - [`[CategoryInterface]`](/reference/graphql/2-4-7/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-7/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#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`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#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`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `manufacturer` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-7/types-k-p.md#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`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-7/types-c-e.md#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`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-7/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-7/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-7/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#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!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `review_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#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`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#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`](types-f-i.md#float) | The discounted price of the product. | +| `special_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The discounted price of the product. | | `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-7/types-k-p.md#productstockstatus) | Stock status of the product | | `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-7/types-t-z.md#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!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#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]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-7/types-t-z.md#urlrewrite) | URL rewrites list | | `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/2-4-7/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "attribute_set_id": 987, + "attribute_set_id": 123, "canonical_url": "xyz789", "categories": [CategoryInterface], "color": 123, @@ -2982,16 +2979,16 @@ Defines a simple product, which is tangible and is usually sold in single units "id": 987, "image": ProductImage, "is_returnable": "xyz789", - "manufacturer": 987, + "manufacturer": 123, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "name": "xyz789", "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", "price": ProductPrices, @@ -3007,26 +3004,26 @@ Defines a simple product, which is tangible and is usually sold in single units "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 123.45, - "special_to_date": "xyz789", + "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", - "uid": 4, + "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -3040,8 +3037,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-7/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-7/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -3063,9 +3060,9 @@ Contains details about simple products added to a requisition list. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3073,8 +3070,8 @@ Contains details about simple products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -3091,9 +3088,9 @@ Contains a simple 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!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -3101,8 +3098,8 @@ Contains a simple product wish list item. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -3126,7 +3123,7 @@ Smart button payment inputs ```json { - "payment_source": "abc123", + "payment_source": "xyz789", "payments_order_id": "abc123", "paypal_order_id": "abc123" } @@ -3140,12 +3137,12 @@ Smart button payment inputs | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](types-a-b.md#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `button_styles` - [`ButtonStyles`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](types-k-p.md#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `display_message` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](/reference/graphql/2-4-7/types-k-p.md#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 | @@ -3156,14 +3153,14 @@ Smart button payment inputs ```json { "button_styles": ButtonStyles, - "code": "abc123", + "code": "xyz789", "display_message": false, "display_venmo": false, "is_visible": false, "message_styles": MessageStyles, "payment_intent": "abc123", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "title": "abc123" } ``` @@ -3205,7 +3202,7 @@ Defines a possible sort field. ```json { "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -3299,27 +3296,27 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `autocomplete_on_storefront` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | -| `braintree_3dsecure_always_request_3ds` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure, always request 3D Secure flag. | +| `braintree_3dsecure_allowspecific` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | -| `braintree_ach_direct_debit_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree ACH vault status. | +| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Braintree ACH vault status. | | `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | -| `braintree_applepay_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree Apple Pay vault status. | +| `braintree_applepay_vault_active` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Braintree Apple Pay vault status. | | `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | -| `braintree_cc_vault_cvv` - [`Boolean`](types-a-b.md#boolean) | Braintree cc vault CVV re-verification enabled status. | +| `braintree_cc_vault_cvv` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree Google Pay vault status. | +| `braintree_googlepay_vault_active` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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. | @@ -3327,116 +3324,116 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | +| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal mini-cart & cart button show. | +| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Credit checkout button show status. | +| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging checkout show status. | +| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later checkout button show status. | +| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal checkout button show. | +| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Credit PDP button show status. | +| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging PDP show status. | +| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later PDP button show status. | +| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal PDP button show. | +| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Should display Braintree PayPal in mini-cart & cart? | +| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | -| `braintree_paypal_send_cart_line_items` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | -| `braintree_paypal_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree PayPal vault status. | -| `cart_expires_in_days` - [`Int`](types-f-i.md#int) | Extended Config Data - checkout/cart/delete_quote_after | +| `braintree_paypal_require_billing_address` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#int) | Extended Config Data - checkout/cart_link/use_qty | +| `cart_summary_display_quantity` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-7/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#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_sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether the Contact Us form in enabled. | +| `contact_enabled` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](types-f-i.md#float) | Customer access token lifetime. | +| `create_account_confirmation` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#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`](types-a-b.md#boolean) | Extended Config Data - general/region/display_all | +| `demonotice` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#int) | The default number of products per page in Grid View. | +| `grid_per_page` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - checkout/options/guest_checkout | -| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - checkout/options/onepage_checkout_enabled | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_default_store` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Extended Config Data - checkout/options/guest_checkout | +| `is_negotiable_quote_active` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#int) | The default number of products per page in List View. | +| `list_per_page` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](types-f-i.md#int) | The width of the logo image, in pixels. | +| `logo_height` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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. | @@ -3451,27 +3448,27 @@ Contains information about a store's configuration. | `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`](types-f-i.md#int) | Extended Config Data - checkout/options/max_items_display_count | +| `max_items_in_order_summary` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-a-b.md#boolean) | Extended Config Data - checkout/sidebar/display | -| `minicart_max_items` - [`Int`](types-f-i.md#int) | Extended Config Data - checkout/sidebar/count | +| `minicart_display` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Extended Config Data - checkout/sidebar/display | +| `minicart_max_items` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether newsletters are enabled. | +| `newsletter_enabled` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | +| `order_cancellation_enabled` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](/reference/graphql/2-4-7/types-c-e.md#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`](types-f-i.md#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_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-7/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether quick order functionality is enabled. | +| `quickorder_active` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `root_category_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-7/types-f-i.md#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`. | @@ -3479,35 +3476,35 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `show_cms_breadcrumbs` - [`Int`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `shopping_cart_display_full_summary` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](/reference/graphql/2-4-7/types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-f-i.md#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`](types-f-i.md#int) | The store view sort order. | +| `store_sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | -| `website_id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `use_store_in_url` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_enable_for_specific_countries` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#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`](types-f-i.md#int) | A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout. | +| `zero_subtotal_sort_order` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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 @@ -3516,220 +3513,220 @@ Contains information about a store's configuration. { "absolute_footer": "xyz789", "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "xyz789", + "allow_guests_to_write_product_reviews": "abc123", "allow_items": "xyz789", "allow_order": "xyz789", - "allow_printed_card": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": false, "base_currency_code": "abc123", - "base_link_url": "xyz789", - "base_media_url": "xyz789", - "base_static_url": "abc123", - "base_url": "xyz789", + "base_link_url": "abc123", + "base_media_url": "abc123", + "base_static_url": "xyz789", + "base_url": "abc123", "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": 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_ach_direct_debit_vault_active": false, "braintree_applepay_merchant_name": "abc123", - "braintree_applepay_vault_active": true, - "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": false, + "braintree_applepay_vault_active": false, + "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_cvv": true, "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "abc123", + "braintree_googlepay_btn_color": "xyz789", "braintree_googlepay_cctypes": "abc123", "braintree_googlepay_merchant_id": "xyz789", - "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_googlepay_vault_active": true, + "braintree_local_payment_allowed_methods": "xyz789", + "braintree_local_payment_fallback_button_text": "xyz789", + "braintree_local_payment_redirect_on_fail": "xyz789", + "braintree_merchant_account_id": "abc123", "braintree_paypal_button_location_cart_type_credit_color": "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_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": "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": "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": "abc123", + "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123", + "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_label": "abc123", + "braintree_paypal_button_location_cart_type_paylater_shape": "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_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_color": "xyz789", "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": "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_credit_show": false, + "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123", + "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_show": false, - "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": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_show": true, + "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_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": "xyz789", - "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": "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_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": "abc123", "braintree_paypal_button_location_productpage_type_messaging_show": false, "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_color": "abc123", "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_show": true, - "braintree_paypal_button_location_productpage_type_paypal_color": "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": "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": false, + "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": "xyz789", + "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_vault_active": true, + "braintree_paypal_require_billing_address": true, + "braintree_paypal_send_cart_line_items": true, + "braintree_paypal_vault_active": false, "cart_expires_in_days": 123, - "cart_gift_wrapping": "abc123", + "cart_gift_wrapping": "xyz789", "cart_printed_card": "abc123", - "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "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": "abc123", + "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": "xyz789", "check_money_order_new_order_status": "abc123", "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 123, + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 987, "check_money_order_title": "xyz789", - "cms_home_page": "abc123", + "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", "cms_no_route": "xyz789", "code": "abc123", "configurable_thumbnail_source": "xyz789", - "contact_enabled": false, - "copyright": "xyz789", + "contact_enabled": true, + "copyright": "abc123", "countries_with_required_region": "abc123", "create_account_confirmation": false, "customer_access_token_lifetime": 987.65, "default_country": "abc123", "default_description": "xyz789", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_keywords": "abc123", "default_title": "xyz789", "demonotice": 123, "display_state_if_optional": false, - "enable_multiple_wishlists": "xyz789", + "enable_multiple_wishlists": "abc123", "front": "abc123", - "grid_per_page": 987, - "grid_per_page_values": "xyz789", + "grid_per_page": 123, + "grid_per_page_values": "abc123", "head_includes": "abc123", "head_shortcut_icon": "abc123", - "header_logo_src": "xyz789", - "id": 123, + "header_logo_src": "abc123", + "id": 987, "is_default_store": true, "is_default_store_group": true, - "is_guest_checkout_enabled": false, + "is_guest_checkout_enabled": true, "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "abc123", - "list_mode": "xyz789", + "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": 987, - "magento_reward_general_is_enabled": "abc123", + "locale": "abc123", + "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": "abc123", - "magento_reward_general_publish_history": "abc123", - "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_general_publish_history": "xyz789", + "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "xyz789", - "magento_reward_points_invitation_order": "abc123", - "magento_reward_points_invitation_order_limit": "abc123", + "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "abc123", - "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "abc123", + "magento_reward_points_order": "xyz789", + "magento_reward_points_register": "abc123", + "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, + "magento_wishlist_general_is_enabled": "abc123", + "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", - "order_cancellation_enabled": false, + "newsletter_enabled": false, + "no_route": "abc123", + "optional_zip_countries": "abc123", + "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], - "payment_payflowpro_cc_vault_active": "abc123", - "printed_card_price": "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_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, + "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", + "sales_printed_card": "abc123", "secure_base_link_url": "abc123", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_media_url": "abc123", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, - "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": 987, "shopping_cart_display_shipping": 123, - "shopping_cart_display_subtotal": 987, + "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 123, "store_code": 4, - "store_group_code": "4", - "store_group_name": "abc123", - "store_name": "xyz789", + "store_group_code": 4, + "store_group_name": "xyz789", + "store_name": "abc123", "store_sort_order": 123, - "timezone": "abc123", - "title_prefix": "abc123", - "title_separator": "abc123", + "timezone": "xyz789", + "title_prefix": "xyz789", + "title_separator": "xyz789", "title_suffix": "abc123", - "use_store_in_url": true, + "use_store_in_url": false, "website_code": "4", - "website_id": 987, + "website_id": 123, "website_name": "abc123", "weight_unit": "abc123", - "welcome": "xyz789", - "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, + "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_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } @@ -3745,17 +3742,17 @@ Indicates where an attribute can be displayed. | Field Name | Description | |------------|-------------| -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | +| `position` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](/reference/graphql/2-4-7/types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example ```json { - "position": 987, + "position": 123, "use_in_layered_navigation": "NO", "use_in_product_listing": true, "use_in_search_results_layered_navigation": true, @@ -3774,7 +3771,7 @@ represent free-form human-readable text. #### Example ```json -"abc123" +"xyz789" ``` @@ -3788,20 +3785,20 @@ Specifies the quote template properties to update. | Input Field | Description | |-------------|-------------| | `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for minimum orders | +| `max_order_commitment` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Commitment for minimum orders | | `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "comment": "xyz789", - "max_order_commitment": 123, - "min_order_commitment": 987, + "comment": "abc123", + "max_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", - "template_id": "4" + "template_id": 4 } ``` @@ -3861,7 +3858,7 @@ Describes the swatch type and a value. ```json { - "type": "abc123", + "type": "xyz789", "value": "xyz789" } ``` @@ -3880,14 +3877,14 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | -| [`TextSwatchData`](types-t-z.md#textswatchdata) | -| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | +| [`ImageSwatchData`](/reference/graphql/2-4-7/types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](/reference/graphql/2-4-7/types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](/reference/graphql/2-4-7/types-c-e.md#colorswatchdata) | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -3933,7 +3930,7 @@ Swatch attribute metadata input types. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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.)* | @@ -3942,7 +3939,7 @@ Swatch attribute metadata input types. ```json { - "items_count": 123, + "items_count": 987, "label": "abc123", "swatch_data": SwatchData, "value_string": "xyz789" @@ -3989,7 +3986,7 @@ Synchronizes the payment order details ```json { "cartId": "xyz789", - "id": "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 index 62643eb64..3eae117d0 100644 --- 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 @@ -8,9 +8,9 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | -| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | +| `amount` - [`Money!`](/reference/graphql/2-4-7/types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A title that describes the tax. | #### Example @@ -48,12 +48,12 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -66,9 +66,9 @@ Defines a price based on the quantity purchased. | Field Name | Description | |------------|-------------| -| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | -| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | +| `discount` - [`ProductDiscount`](/reference/graphql/2-4-7/types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](/reference/graphql/2-4-7/types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -76,7 +76,7 @@ Defines a price based on the quantity purchased. { "discount": ProductDiscount, "final_price": Money, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -90,8 +90,8 @@ Modifies the specified items in the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | +| `cart_id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](/reference/graphql/2-4-7/types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example @@ -112,7 +112,7 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-7/types-c-e.md#cart) | The cart after updating products. | #### Example @@ -130,7 +130,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/2-4-7/types-c-e.md#company) | The updated company instance. | #### Example @@ -148,7 +148,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](/reference/graphql/2-4-7/types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -166,7 +166,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/2-4-7/types-c-e.md#company) | The updated company instance. | #### Example @@ -184,7 +184,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](/reference/graphql/2-4-7/types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -202,7 +202,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | +| `user` - [`Customer!`](/reference/graphql/2-4-7/types-c-e.md#customer) | The updated company user instance. | #### Example @@ -220,12 +220,12 @@ Defines updates to a `GiftRegistry` object. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | -| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-7/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](/reference/graphql/2-4-7/types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/2-4-7/types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](/reference/graphql/2-4-7/types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -252,16 +252,16 @@ Defines updates to an item in a gift registry. | Input Field | Description | |-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | +| `gift_registry_item_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { "gift_registry_item_uid": "4", - "note": "xyz789", + "note": "abc123", "quantity": 987.65 } ``` @@ -276,7 +276,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -294,7 +294,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -312,11 +312,11 @@ Defines updates to an existing registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | -| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-7/types-f-i.md#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`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -327,7 +327,7 @@ Defines updates to an existing registrant. ], "email": "abc123", "firstname": "abc123", - "gift_registry_registrant_uid": "4", + "gift_registry_registrant_uid": 4, "lastname": "abc123" } ``` @@ -342,7 +342,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-7/types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -360,7 +360,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-7/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -378,8 +378,8 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](/reference/graphql/2-4-7/types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -400,7 +400,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -418,8 +418,8 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](/reference/graphql/2-4-7/types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -462,25 +462,25 @@ Defines the changes to be made to an approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | -| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | +| `applies_to` - [`[ID]`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](/reference/graphql/2-4-7/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](/reference/graphql/2-4-7/types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { "applies_to": ["4"], - "approvers": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "abc123", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": 4 + "uid": "4" } ``` @@ -494,15 +494,15 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The new name of the requisition list. | #### Example ```json { - "description": "abc123", - "name": "xyz789" + "description": "xyz789", + "name": "abc123" } ``` @@ -516,18 +516,18 @@ Defines which items in a requisition list to update. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-7/types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](/reference/graphql/2-4-7/types-q-s.md#string) | An array of selected option IDs. | #### Example ```json { "entered_options": [EnteredOptionInput], - "item_id": "4", - "quantity": 987.65, + "item_id": 4, + "quantity": 123.45, "selected_options": ["abc123"] } ``` @@ -542,7 +542,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -560,7 +560,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-7/types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -578,8 +578,8 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The wish list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of a `Wishlist` object. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -602,15 +602,15 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](types-q-s.md#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](/reference/graphql/2-4-7/types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The request URL. | #### Example ```json { "parameters": [HttpQueryParameter], - "url": "xyz789" + "url": "abc123" } ``` @@ -664,16 +664,16 @@ Defines the input for returning matching companies the customer is assigned to. | Input Field | Description | |-------------|-------------| -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | -| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | +| `currentPage` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](/reference/graphql/2-4-7/types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example ```json { - "currentPage": 123, - "pageSize": 123, + "currentPage": 987, + "pageSize": 987, "sort": [CompaniesSortInput] } ``` @@ -688,8 +688,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](/reference/graphql/2-4-7/types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -710,7 +710,7 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example @@ -749,7 +749,7 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of the purchase order IDs. | #### Example @@ -768,7 +768,7 @@ Contains the results of validation attempts. | Field Name | Description | |------------|-------------| | `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | +| `purchase_orders` - [`[PurchaseOrder]!`](/reference/graphql/2-4-7/types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -790,7 +790,7 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](types-q-s.md#string) | Validation rule value. | +| `value` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Validation rule value. | #### Example @@ -837,10 +837,10 @@ Vault payment inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | +| `payment_source` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The public hash of the token. | #### Example @@ -848,8 +848,8 @@ Vault payment inputs { "payment_source": "abc123", "payments_order_id": "xyz789", - "paypal_order_id": "xyz789", - "public_hash": "xyz789" + "paypal_order_id": "abc123", + "public_hash": "abc123" } ``` @@ -863,7 +863,7 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The public hash of the payment token. | #### Example @@ -881,19 +881,19 @@ An implementation for virtual product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-7/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-7/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-7/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-7/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -902,15 +902,15 @@ An implementation for virtual product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "xyz789", - "is_available": false, - "max_qty": 987.65, + "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, + "quantity": 987.65, "uid": 4 } ``` @@ -925,62 +925,62 @@ Defines a virtual product, which is a non-tangible product that does not require | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](types-q-s.md#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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]`](/reference/graphql/2-4-7/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-7/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-7/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-7/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-7/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-7/types-k-p.md#pricerange) | The range of prices for the product | | `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-7/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-7/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-7/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-7/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-7/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-7/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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]`](/reference/graphql/2-4-7/types-k-p.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `type_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | | `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `url_suffix` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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 @@ -990,9 +990,9 @@ Defines a virtual product, which is a non-tangible product that does not require "attribute_set_id": 123, "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "abc123", - "created_at": "abc123", + "color": 123, + "country_of_manufacture": "xyz789", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -1000,15 +1000,15 @@ Defines a virtual product, which is a non-tangible product that does not require "id": 123, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 987, + "manufacturer": 123, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_description": "xyz789", + "meta_keyword": "abc123", "meta_title": "xyz789", - "name": "abc123", + "name": "xyz789", "new_from_date": "abc123", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", @@ -1020,29 +1020,29 @@ Defines a virtual product, which is a non-tangible product that does not require "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "xyz789", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 123.45, "special_to_date": "abc123", - "staged": false, + "staged": true, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": 4, "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website] } ``` @@ -1057,8 +1057,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-7/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-7/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -1079,10 +1079,10 @@ Contains details about virtual products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1090,7 +1090,7 @@ Contains details about virtual products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -1105,21 +1105,21 @@ Contains a virtual product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, "quantity": 987.65 } @@ -1135,12 +1135,12 @@ Deprecated. It should not be used on the storefront. Contains information about | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](types-q-s.md#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`](types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | +| `code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](/reference/graphql/2-4-7/types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](/reference/graphql/2-4-7/types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | #### Example @@ -1148,10 +1148,10 @@ Deprecated. It should not be used on the storefront. Contains information about { "code": "xyz789", "default_group_id": "abc123", - "id": 987, - "is_default": true, - "name": "abc123", - "sort_order": 123 + "id": 123, + "is_default": false, + "name": "xyz789", + "sort_order": 987 } ``` @@ -1166,7 +1166,7 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message. | #### Example @@ -1206,13 +1206,13 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `Wishlist` object. | | `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. | +| `items_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#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`](types-q-s.md#string) | The name of the wish list. | -| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The time of the last modification to the wish list. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -1221,7 +1221,7 @@ Contains a customer wish list. { "id": 4, "items": [WishlistItem], - "items_count": 123, + "items_count": 987, "items_v2": WishlistItems, "name": "xyz789", "sharing_code": "xyz789", @@ -1241,18 +1241,18 @@ Contains details about errors encountered when a customer added wish list items | Field Name | Description | |------------|-------------| | `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | +| `message` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "wishlistId": 4, - "wishlistItemId": 4 + "message": "xyz789", + "wishlistId": "4", + "wishlistItemId": "4" } ``` @@ -1287,21 +1287,21 @@ Contains details about a wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | +| `added_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "description": "xyz789", "id": 987, "product": ProductInterface, - "qty": 123.45 + "qty": 987.65 } ``` @@ -1315,16 +1315,13 @@ Specifies the IDs of items to copy and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json -{ - "quantity": 123.45, - "wishlist_item_id": "4" -} +{"quantity": 123.45, "wishlist_item_id": 4} ``` @@ -1337,21 +1334,21 @@ Defines the items to add to a wish list. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-7/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#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, + "parent_sku": "abc123", + "quantity": 987.65, "selected_options": ["4"], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -1365,35 +1362,35 @@ The interface for wish list items. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-7/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-7/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-7/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-7/types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | +| [`SimpleWishlistItem`](/reference/graphql/2-4-7/types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | -| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | -| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | -| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](/reference/graphql/2-4-7/types-c-e.md#configurablewishlistitem) | +| [`DownloadableWishlistItem`](/reference/graphql/2-4-7/types-c-e.md#downloadablewishlistitem) | +| [`BundleWishlistItem`](/reference/graphql/2-4-7/types-a-b.md#bundlewishlistitem) | +| [`GiftCardWishlistItem`](/reference/graphql/2-4-7/types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](/reference/graphql/2-4-7/types-f-i.md#groupedproductwishlistitem) | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, + "description": "xyz789", + "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1407,16 +1404,13 @@ Specifies the IDs of the items to move and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#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!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json -{ - "quantity": 123.45, - "wishlist_item_id": "4" -} +{"quantity": 987.65, "wishlist_item_id": 4} ``` @@ -1429,11 +1423,11 @@ Defines updates to items in a wish list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `description` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-7/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](/reference/graphql/2-4-7/types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-7/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](/reference/graphql/2-4-7/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example @@ -1458,7 +1452,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-7/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1480,10 +1474,10 @@ Deprecated: Use the `Wishlist` type instead. | 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`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-7/types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](/reference/graphql/2-4-7/types-q-s.md#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`](/reference/graphql/2-4-7/types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-7/types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | #### Example @@ -1491,9 +1485,9 @@ Deprecated: Use the `Wishlist` type instead. { "items": [WishlistItem], "items_count": 123, - "name": "xyz789", - "sharing_code": "xyz789", - "updated_at": "xyz789" + "name": "abc123", + "sharing_code": "abc123", + "updated_at": "abc123" } ``` 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 ec90b769d..a32c03e01 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 @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](/reference/graphql/2-4-8/types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](/reference/graphql/2-4-8/types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": false}}} +{"data": {"acceptCompanyInvitation": {"success": true}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-8/types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -111,7 +111,7 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 987, @@ -125,7 +125,7 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -138,13 +138,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](/reference/graphql/2-4-8/types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -178,13 +178,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](/reference/graphql/2-4-8/types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -222,13 +222,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](/reference/graphql/2-4-8/types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -266,14 +266,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-8/types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](/reference/graphql/2-4-8/types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -299,7 +299,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -322,14 +322,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](/reference/graphql/2-4-8/types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -382,13 +382,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-8/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](/reference/graphql/2-4-8/types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -424,7 +424,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -436,14 +436,14 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](/reference/graphql/2-4-8/types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](/reference/graphql/2-4-8/types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -492,14 +492,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](/reference/graphql/2-4-8/types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -552,13 +552,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](/reference/graphql/2-4-8/types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](/reference/graphql/2-4-8/types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -598,13 +598,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](/reference/graphql/2-4-8/types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -648,14 +648,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -686,7 +686,7 @@ mutation addRequisitionListItemsToCart( ```json { "requisitionListUid": "4", - "requisitionListItemUids": [4] + "requisitionListItemUids": ["4"] } ``` @@ -712,13 +712,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](/reference/graphql/2-4-8/types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](/reference/graphql/2-4-8/types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -752,13 +752,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](/reference/graphql/2-4-8/types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](/reference/graphql/2-4-8/types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -802,13 +802,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](/reference/graphql/2-4-8/types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -842,13 +842,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](/reference/graphql/2-4-8/types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -882,14 +882,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -918,7 +918,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": "4", "wishlistItemIds": [4]} +{"wishlistId": 4, "wishlistItemIds": [4]} ``` ##### Response @@ -930,7 +930,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": true, + "status": false, "wishlist": Wishlist } } @@ -943,13 +943,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](/reference/graphql/2-4-8/types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -983,13 +983,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](/reference/graphql/2-4-8/types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1023,13 +1023,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](/reference/graphql/2-4-8/types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -1063,13 +1063,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -1088,7 +1088,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -1103,13 +1103,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](/reference/graphql/2-4-8/types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](/reference/graphql/2-4-8/types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1143,13 +1143,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-8/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-8/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1193,13 +1193,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](/reference/graphql/2-4-8/types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1241,13 +1241,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -1317,7 +1317,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -1336,20 +1336,20 @@ mutation assignCustomerToGuestCart($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", "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], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1361,13 +1361,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-8/types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1429,12 +1429,12 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1457,13 +1457,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/2-4-8/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](/reference/graphql/2-4-8/types-c-e.md#cancelorderinput) | | #### Example @@ -1509,13 +1509,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-8/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-8/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1559,14 +1559,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/2-4-8/types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | +| `currentPassword` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's updated password. | #### Example @@ -1691,7 +1691,7 @@ mutation changeCustomerPassword( ```json { "currentPassword": "xyz789", - "newPassword": "xyz789" + "newPassword": "abc123" } ``` @@ -1707,32 +1707,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", + "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "abc123", + "default_shipping": "xyz789", "dob": "xyz789", "email": "xyz789", - "firstname": "abc123", - "gender": 123, + "firstname": "xyz789", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroup, - "group_id": 123, + "group_id": 987, "id": 987, "is_subscribed": true, "job_title": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, + "purchase_orders_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1742,11 +1742,11 @@ mutation changeCustomerPassword( "segments": [CustomerSegment], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1761,13 +1761,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCartOutput!`](types-c-e.md#clearcartoutput) +**Response:** [`ClearCartOutput!`](/reference/graphql/2-4-8/types-c-e.md#clearcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ClearCartInput!`](types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | +| `input` - [`ClearCartInput!`](/reference/graphql/2-4-8/types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | #### Example @@ -1811,13 +1811,13 @@ mutation clearCart($input: ClearCartInput!) { Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](/reference/graphql/2-4-8/types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1837,7 +1837,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "abc123"} +{"cartUid": "xyz789"} ``` ##### Response @@ -1845,7 +1845,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": true} + "clearCustomerCart": {"cart": Cart, "status": false} } } ``` @@ -1856,13 +1856,13 @@ mutation clearCustomerCart($cartUid: String!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](/reference/graphql/2-4-8/types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](/reference/graphql/2-4-8/types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1919,13 +1919,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Cancel the specified guest customer order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/2-4-8/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmCancelOrderInput!`](types-c-e.md#confirmcancelorderinput) | | +| `input` - [`ConfirmCancelOrderInput!`](/reference/graphql/2-4-8/types-c-e.md#confirmcancelorderinput) | | #### Example @@ -1957,7 +1957,7 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { { "data": { "confirmCancelOrder": { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1971,13 +1971,13 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-8/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](/reference/graphql/2-4-8/types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -2011,13 +2011,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Confirm the return. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/2-4-8/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmReturnInput!`](types-c-e.md#confirmreturninput) | | +| `input` - [`ConfirmReturnInput!`](/reference/graphql/2-4-8/types-c-e.md#confirmreturninput) | | #### Example @@ -2061,13 +2061,13 @@ mutation confirmReturn($input: ConfirmReturnInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) +**Response:** [`ContactUsOutput`](/reference/graphql/2-4-8/types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](/reference/graphql/2-4-8/types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -2090,7 +2090,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": false}}} +{"data": {"contactUs": {"status": true}}} ``` @@ -2099,15 +2099,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](/reference/graphql/2-4-8/types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](/reference/graphql/2-4-8/types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2135,8 +2135,8 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": 4, + "sourceRequisitionListUid": 4, + "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2159,15 +2159,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](/reference/graphql/2-4-8/types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2201,7 +2201,7 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, + "sourceWishlistUid": "4", "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } @@ -2227,7 +2227,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) #### Example @@ -2244,7 +2244,7 @@ mutation createBraintreeClientToken { ```json { "data": { - "createBraintreeClientToken": "abc123" + "createBraintreeClientToken": "xyz789" } } ``` @@ -2255,7 +2255,7 @@ mutation createBraintreeClientToken { Creates Client Token for Braintree PayPal Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) #### Example @@ -2272,7 +2272,7 @@ mutation createBraintreePayPalClientToken { ```json { "data": { - "createBraintreePayPalClientToken": "abc123" + "createBraintreePayPalClientToken": "xyz789" } } ``` @@ -2283,13 +2283,13 @@ mutation createBraintreePayPalClientToken { Creates Client Token for Braintree PayPal Vault Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `input` - [`BraintreeVaultInput`](/reference/graphql/2-4-8/types-a-b.md#braintreevaultinput) | | #### Example @@ -2323,13 +2323,13 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](/reference/graphql/2-4-8/types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](/reference/graphql/2-4-8/types-c-e.md#companycreateinput) | | #### Example @@ -2363,13 +2363,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](/reference/graphql/2-4-8/types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](/reference/graphql/2-4-8/types-c-e.md#companyrolecreateinput) | | #### Example @@ -2403,13 +2403,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](/reference/graphql/2-4-8/types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](/reference/graphql/2-4-8/types-c-e.md#companyteamcreateinput) | | #### Example @@ -2443,13 +2443,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](/reference/graphql/2-4-8/types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](/reference/graphql/2-4-8/types-c-e.md#companyusercreateinput) | | #### Example @@ -2483,13 +2483,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-8/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](/reference/graphql/2-4-8/types-c-e.md#createcomparelistinput) | | #### Example @@ -2525,7 +2525,7 @@ mutation createCompareList($input: CreateCompareListInput) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -2539,13 +2539,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-8/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](/reference/graphql/2-4-8/types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -2579,13 +2579,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/2-4-8/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](/reference/graphql/2-4-8/types-c-e.md#customeraddressinput) | | #### Example @@ -2641,28 +2641,28 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { { "data": { "createCustomerAddress": { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": false, + "default_billing": true, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "abc123", - "id": 123, + "firstname": "xyz789", + "id": 987, "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", + "suffix": "xyz789", + "telephone": "abc123", "vat_id": "xyz789" } } @@ -2675,13 +2675,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-8/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](/reference/graphql/2-4-8/types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2719,13 +2719,13 @@ Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](types-q-s.md#string) +**Response:** [`String`](/reference/graphql/2-4-8/types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](/reference/graphql/2-4-8/types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2755,13 +2755,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](/reference/graphql/2-4-8/types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](/reference/graphql/2-4-8/types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2799,13 +2799,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](/reference/graphql/2-4-8/types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](/reference/graphql/2-4-8/types-c-e.md#createguestcartinput) | | #### Example @@ -2839,13 +2839,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](/reference/graphql/2-4-8/types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](/reference/graphql/2-4-8/types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -2875,10 +2875,10 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "abc123", + "response_message": "xyz789", "result": 123, - "result_code": 123, - "secure_token": "abc123", + "result_code": 987, + "secure_token": "xyz789", "secure_token_id": "xyz789" } } @@ -2891,13 +2891,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](/reference/graphql/2-4-8/types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](/reference/graphql/2-4-8/types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -2927,10 +2927,10 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 987.65, - "currency_code": "abc123", - "id": "abc123", - "mp_order_id": "abc123", + "amount": 123.45, + "currency_code": "xyz789", + "id": "xyz789", + "mp_order_id": "xyz789", "status": "xyz789" } } @@ -2943,13 +2943,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](/reference/graphql/2-4-8/types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](/reference/graphql/2-4-8/types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2991,13 +2991,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](/reference/graphql/2-4-8/types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](/reference/graphql/2-4-8/types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -3035,13 +3035,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -3090,7 +3090,7 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "description": "abc123", "name": "abc123", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -3103,13 +3103,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](/reference/graphql/2-4-8/types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](/reference/graphql/2-4-8/types-c-e.md#createrequisitionlistinput) | | #### Example @@ -3149,13 +3149,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Creates a vault payment token -**Response:** [`CreateVaultCardPaymentTokenOutput`](types-c-e.md#createvaultcardpaymenttokenoutput) +**Response:** [`CreateVaultCardPaymentTokenOutput`](/reference/graphql/2-4-8/types-c-e.md#createvaultcardpaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardPaymentTokenInput!`](types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | +| `input` - [`CreateVaultCardPaymentTokenInput!`](/reference/graphql/2-4-8/types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | #### Example @@ -3185,7 +3185,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } } } @@ -3197,13 +3197,13 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) Creates a vault card setup token -**Response:** [`CreateVaultCardSetupTokenOutput`](types-c-e.md#createvaultcardsetuptokenoutput) +**Response:** [`CreateVaultCardSetupTokenOutput`](/reference/graphql/2-4-8/types-c-e.md#createvaultcardsetuptokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardSetupTokenInput!`](types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | +| `input` - [`CreateVaultCardSetupTokenInput!`](/reference/graphql/2-4-8/types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | #### Example @@ -3229,7 +3229,7 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { { "data": { "createVaultCardSetupToken": { - "setup_token": "abc123" + "setup_token": "xyz789" } } } @@ -3241,13 +3241,13 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](/reference/graphql/2-4-8/types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](/reference/graphql/2-4-8/types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -3281,13 +3281,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](/reference/graphql/2-4-8/types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -3304,7 +3304,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3319,13 +3319,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](/reference/graphql/2-4-8/types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -3342,13 +3342,13 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": false}}} +{"data": {"deleteCompanyTeam": {"success": true}}} ``` @@ -3361,13 +3361,13 @@ Use deleteCompanyUserV2 instead. The current method only deactivates the user ac Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/2-4-8/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -3384,7 +3384,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3399,13 +3399,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/2-4-8/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -3422,7 +3422,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3437,13 +3437,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](/reference/graphql/2-4-8/types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3460,13 +3460,13 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response ```json -{"data": {"deleteCompareList": {"result": false}}} +{"data": {"deleteCompareList": {"result": true}}} ``` @@ -3475,7 +3475,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Example @@ -3499,13 +3499,13 @@ mutation deleteCustomer { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3526,7 +3526,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": true}} +{"data": {"deleteCustomerAddress": false}} ``` @@ -3535,13 +3535,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete a negotiable quote template -**Response:** [`Boolean!`](types-a-b.md#boolean) +**Response:** [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-8/types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3571,13 +3571,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](/reference/graphql/2-4-8/types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](/reference/graphql/2-4-8/types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3630,13 +3630,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](/reference/graphql/2-4-8/types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3666,7 +3666,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } } } @@ -3678,13 +3678,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](/reference/graphql/2-4-8/types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-8/types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3724,13 +3724,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](/reference/graphql/2-4-8/types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3772,14 +3772,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](/reference/graphql/2-4-8/types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -3804,10 +3804,7 @@ mutation deleteRequisitionListItems( ##### Variables ```json -{ - "requisitionListUid": 4, - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -3828,13 +3825,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](/reference/graphql/2-4-8/types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -3854,7 +3851,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -3876,13 +3873,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](/reference/graphql/2-4-8/types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](/reference/graphql/2-4-8/types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -3920,13 +3917,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](/reference/graphql/2-4-8/types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/2-4-8/types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -3974,7 +3971,7 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "available": false, "base_amount": Money, "carrier_code": "abc123", - "carrier_title": "xyz789", + "carrier_title": "abc123", "error_message": "abc123", "method_code": "xyz789", "method_title": "abc123", @@ -3992,13 +3989,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](/reference/graphql/2-4-8/types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/2-4-8/types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -4032,14 +4029,14 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](types-c-e.md#customertoken) +**Response:** [`CustomerToken`](/reference/graphql/2-4-8/types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's password. | #### Example @@ -4064,7 +4061,7 @@ mutation generateCustomerToken( ```json { "email": "xyz789", - "password": "xyz789" + "password": "abc123" } ``` @@ -4074,7 +4071,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "abc123" + "token": "xyz789" } } } @@ -4086,13 +4083,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](/reference/graphql/2-4-8/types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](/reference/graphql/2-4-8/types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -4118,7 +4115,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "abc123" + "customer_token": "xyz789" } } } @@ -4130,13 +4127,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](/reference/graphql/2-4-8/types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](/reference/graphql/2-4-8/types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -4174,13 +4171,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](/reference/graphql/2-4-8/types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](/reference/graphql/2-4-8/types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -4214,14 +4211,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | -| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | +| `source_cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4298,7 +4295,7 @@ mutation mergeCarts( ```json { - "source_cart_id": "xyz789", + "source_cart_id": "abc123", "destination_cart_id": "abc123" } ``` @@ -4321,18 +4318,18 @@ mutation mergeCarts( "billing_address": BillingCartAddress, "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, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -4344,14 +4341,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-8/types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4380,10 +4377,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{ - "cartUid": "4", - "giftRegistryUid": "4" -} +{"cartUid": 4, "giftRegistryUid": 4} ``` ##### Response @@ -4406,15 +4400,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](/reference/graphql/2-4-8/types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](/reference/graphql/2-4-8/types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4446,7 +4440,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": 4, + "destinationRequisitionListUid": "4", "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4470,13 +4464,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](/reference/graphql/2-4-8/types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](/reference/graphql/2-4-8/types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4516,15 +4510,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](/reference/graphql/2-4-8/types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4558,8 +4552,8 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", - "destinationWishlistUid": 4, + "sourceWishlistUid": 4, + "destinationWishlistUid": "4", "wishlistItems": [WishlistItemMoveInput] } ``` @@ -4584,13 +4578,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-8/types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4650,14 +4644,14 @@ 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": 987, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -4680,13 +4674,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](/reference/graphql/2-4-8/types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](/reference/graphql/2-4-8/types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4720,13 +4714,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/2-4-8/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](/reference/graphql/2-4-8/types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4774,13 +4768,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](/reference/graphql/2-4-8/types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](/reference/graphql/2-4-8/types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -4818,13 +4812,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](/reference/graphql/2-4-8/types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](/reference/graphql/2-4-8/types-k-p.md#placepurchaseorderinput) | | #### Example @@ -4864,13 +4858,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/2-4-8/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/2-4-8/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -4901,8 +4895,8 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } } } @@ -4914,13 +4908,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/2-4-8/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/2-4-8/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -4964,13 +4958,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/2-4-8/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](/reference/graphql/2-4-8/types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -5004,13 +4998,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/2-4-8/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](/reference/graphql/2-4-8/types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -5044,13 +5038,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](/reference/graphql/2-4-8/types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](/reference/graphql/2-4-8/types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -5084,13 +5078,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](/reference/graphql/2-4-8/types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -5107,7 +5101,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -5122,14 +5116,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](/reference/graphql/2-4-8/types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -5154,10 +5148,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{ - "giftRegistryUid": "4", - "itemsUid": ["4"] -} +{"giftRegistryUid": "4", "itemsUid": [4]} ``` ##### Response @@ -5178,14 +5169,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-8/types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -5210,7 +5201,10 @@ mutation removeGiftRegistryRegistrants( ##### Variables ```json -{"giftRegistryUid": 4, "registrantsUid": [4]} +{ + "giftRegistryUid": 4, + "registrantsUid": ["4"] +} ``` ##### Response @@ -5231,13 +5225,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](/reference/graphql/2-4-8/types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](/reference/graphql/2-4-8/types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5271,13 +5265,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](/reference/graphql/2-4-8/types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](/reference/graphql/2-4-8/types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5317,13 +5311,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](/reference/graphql/2-4-8/types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5383,14 +5377,14 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "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, - "min_order_commitment": 123, - "name": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 987, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -5413,13 +5407,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-8/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](/reference/graphql/2-4-8/types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5453,9 +5447,9 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -5467,14 +5461,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](/reference/graphql/2-4-8/types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5502,7 +5496,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": ["4"]} +{"wishlistId": "4", "wishlistItemsIds": [4]} ``` ##### Response @@ -5524,13 +5518,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](/reference/graphql/2-4-8/types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](/reference/graphql/2-4-8/types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5564,13 +5558,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](/reference/graphql/2-4-8/types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -5589,7 +5583,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -5604,13 +5598,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](/reference/graphql/2-4-8/types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](/reference/graphql/2-4-8/types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5644,13 +5638,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](/reference/graphql/2-4-8/types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](/reference/graphql/2-4-8/types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5688,13 +5682,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](/reference/graphql/2-4-8/types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](types-q-s.md#string) | | +| `orderNumber` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -5716,7 +5710,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "abc123"} +{"orderNumber": "xyz789"} ``` ##### Response @@ -5738,13 +5732,13 @@ mutation reorderItems($orderNumber: String!) { Request to cancel specified guest order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/2-4-8/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderCancelInput!`](types-f-i.md#guestordercancelinput) | | +| `input` - [`GuestOrderCancelInput!`](/reference/graphql/2-4-8/types-f-i.md#guestordercancelinput) | | #### Example @@ -5776,7 +5770,7 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { { "data": { "requestGuestOrderCancel": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -5788,13 +5782,13 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { ### requestGuestReturn -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/2-4-8/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestGuestReturnInput!`](types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | +| `input` - [`RequestGuestReturnInput!`](/reference/graphql/2-4-8/types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | #### Example @@ -5838,13 +5832,13 @@ mutation requestGuestReturn($input: RequestGuestReturnInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](/reference/graphql/2-4-8/types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](/reference/graphql/2-4-8/types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -5882,13 +5876,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](/reference/graphql/2-4-8/types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -5951,10 +5945,10 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, + "max_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -5965,7 +5959,7 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", + "template_id": 4, "total_quantity": 123.45 } } @@ -5978,13 +5972,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's email address. | #### Example @@ -6014,13 +6008,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/2-4-8/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](/reference/graphql/2-4-8/types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -6064,13 +6058,13 @@ mutation requestReturn($input: RequestReturnInput!) { Resends the confirmation email to a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to send the confirmation email to. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address to send the confirmation email to. | #### Example @@ -6085,13 +6079,13 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"resendConfirmationEmail": true}} +{"data": {"resendConfirmationEmail": false}} ``` @@ -6100,15 +6094,15 @@ mutation resendConfirmationEmail($email: String!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's new password. | #### Example @@ -6132,7 +6126,7 @@ mutation resetPassword( ```json { - "email": "abc123", + "email": "xyz789", "resetPasswordToken": "xyz789", "newPassword": "xyz789" } @@ -6150,7 +6144,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](/reference/graphql/2-4-8/types-q-s.md#revokecustomertokenoutput) #### Example @@ -6167,7 +6161,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": false}}} +{"data": {"revokeCustomerToken": {"result": true}}} ``` @@ -6176,13 +6170,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](/reference/graphql/2-4-8/types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](/reference/graphql/2-4-8/types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -6226,13 +6220,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](/reference/graphql/2-4-8/types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](/reference/graphql/2-4-8/types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -6272,13 +6266,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](/reference/graphql/2-4-8/types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](/reference/graphql/2-4-8/types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -6312,13 +6306,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](/reference/graphql/2-4-8/types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](/reference/graphql/2-4-8/types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -6352,13 +6346,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](/reference/graphql/2-4-8/types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](/reference/graphql/2-4-8/types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6392,13 +6386,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](/reference/graphql/2-4-8/types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](/reference/graphql/2-4-8/types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6432,13 +6426,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6478,13 +6472,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6524,13 +6518,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6570,13 +6564,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6616,13 +6610,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/2-4-8/types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6684,12 +6678,12 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "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": 987, - "min_order_commitment": 987, - "name": "abc123", + "max_order_commitment": 123, + "min_order_commitment": 123, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6716,13 +6710,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/2-4-8/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](/reference/graphql/2-4-8/types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -6770,13 +6764,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](/reference/graphql/2-4-8/types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](/reference/graphql/2-4-8/types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -6810,13 +6804,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](/reference/graphql/2-4-8/types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -6882,8 +6876,8 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6893,7 +6887,7 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", + "template_id": 4, "total_quantity": 123.45 } } @@ -6906,13 +6900,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](/reference/graphql/2-4-8/types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](/reference/graphql/2-4-8/types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -6946,13 +6940,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](/reference/graphql/2-4-8/types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](/reference/graphql/2-4-8/types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -6986,15 +6980,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](/reference/graphql/2-4-8/types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](/reference/graphql/2-4-8/types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](/reference/graphql/2-4-8/types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7029,7 +7023,7 @@ mutation shareGiftRegistry( ##### Response ```json -{"data": {"shareGiftRegistry": {"is_shared": false}}} +{"data": {"shareGiftRegistry": {"is_shared": true}}} ``` @@ -7038,13 +7032,13 @@ mutation shareGiftRegistry( Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](/reference/graphql/2-4-8/types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -7109,7 +7103,7 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -7121,7 +7115,7 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -7134,13 +7128,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](/reference/graphql/2-4-8/types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -7157,7 +7151,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -7172,13 +7166,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](/reference/graphql/2-4-8/types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -7199,7 +7193,7 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": false}} +{"data": {"syncPaymentOrder": true}} ``` @@ -7208,13 +7202,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Track that a product was viewed in adobe commerce -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | The sku for a `ProductInterface` object. | +| `sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The sku for a `ProductInterface` object. | #### Example @@ -7229,7 +7223,7 @@ mutation trackViewedProduct($sku: String!) { ##### Variables ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` ##### Response @@ -7244,13 +7238,13 @@ mutation trackViewedProduct($sku: String!) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](/reference/graphql/2-4-8/types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](/reference/graphql/2-4-8/types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -7294,13 +7288,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](/reference/graphql/2-4-8/types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](/reference/graphql/2-4-8/types-c-e.md#companyupdateinput) | | #### Example @@ -7334,13 +7328,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](/reference/graphql/2-4-8/types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](/reference/graphql/2-4-8/types-c-e.md#companyroleupdateinput) | | #### Example @@ -7374,13 +7368,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](/reference/graphql/2-4-8/types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](/reference/graphql/2-4-8/types-c-e.md#companystructureupdateinput) | | #### Example @@ -7414,13 +7408,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](/reference/graphql/2-4-8/types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](/reference/graphql/2-4-8/types-c-e.md#companyteamupdateinput) | | #### Example @@ -7454,13 +7448,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](/reference/graphql/2-4-8/types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](/reference/graphql/2-4-8/types-c-e.md#companyuserupdateinput) | | #### Example @@ -7496,13 +7490,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-8/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](/reference/graphql/2-4-8/types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7536,14 +7530,14 @@ mutation updateCustomer($input: CustomerInput!) { Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/2-4-8/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](/reference/graphql/2-4-8/types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7596,7 +7590,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 987, "input": CustomerAddressInput} +{"id": 123, "input": CustomerAddressInput} ``` ##### Response @@ -7606,27 +7600,27 @@ mutation updateCustomerAddress( "data": { "updateCustomerAddress": { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 123, + "customer_id": 987, "default_billing": true, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "xyz789", - "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", + "id": 123, + "lastname": "abc123", + "middlename": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "abc123", - "telephone": "abc123", + "telephone": "xyz789", "vat_id": "xyz789" } } @@ -7639,14 +7633,14 @@ mutation updateCustomerAddress( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-8/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's password. | #### Example @@ -7673,7 +7667,7 @@ mutation updateCustomerEmail( ```json { "email": "xyz789", - "password": "abc123" + "password": "xyz789" } ``` @@ -7689,13 +7683,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/2-4-8/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](/reference/graphql/2-4-8/types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7729,14 +7723,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](/reference/graphql/2-4-8/types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](/reference/graphql/2-4-8/types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -7762,7 +7756,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "giftRegistry": UpdateGiftRegistryInput } ``` @@ -7783,14 +7777,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](/reference/graphql/2-4-8/types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](/reference/graphql/2-4-8/types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -7816,7 +7810,7 @@ mutation updateGiftRegistryItems( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "items": [UpdateGiftRegistryItemInput] } ``` @@ -7839,14 +7833,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](/reference/graphql/2-4-8/types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](/reference/graphql/2-4-8/types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -7872,7 +7866,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -7895,13 +7889,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](/reference/graphql/2-4-8/types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](/reference/graphql/2-4-8/types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -7941,13 +7935,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](/reference/graphql/2-4-8/types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](/reference/graphql/2-4-8/types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -7987,14 +7981,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](/reference/graphql/2-4-8/types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -8047,13 +8041,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](/reference/graphql/2-4-8/types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -8097,12 +8091,12 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "abc123", - "description": "abc123", + "created_at": "abc123", + "created_by": "xyz789", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -8115,14 +8109,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](/reference/graphql/2-4-8/types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](/reference/graphql/2-4-8/types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -8171,14 +8165,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](/reference/graphql/2-4-8/types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](/reference/graphql/2-4-8/types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -8229,15 +8223,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](/reference/graphql/2-4-8/types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](/reference/graphql/2-4-8/types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -8265,8 +8259,8 @@ mutation updateWishlist( ```json { - "wishlistId": 4, - "name": "xyz789", + "wishlistId": "4", + "name": "abc123", "visibility": "PUBLIC" } ``` @@ -8277,7 +8271,7 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "xyz789", + "name": "abc123", "uid": 4, "visibility": "PUBLIC" } @@ -8291,13 +8285,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](/reference/graphql/2-4-8/types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](/reference/graphql/2-4-8/types-t-z.md#validatepurchaseordersinput) | | #### Example 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 cfbb4c0ea..b1517e45b 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) +**Response:** [`AttributesFormOutput!`](/reference/graphql/2-4-8/types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](types-q-s.md#string) | Form code. | +| `formCode` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Form code. | #### Example @@ -48,7 +48,7 @@ query attributesForm($formCode: String!) { ##### Variables ```json -{"formCode": "xyz789"} +{"formCode": "abc123"} ``` ##### Response @@ -70,14 +70,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](/reference/graphql/2-4-8/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-8/types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](/reference/graphql/2-4-8/types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -130,13 +130,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) +**Response:** [`[StoreConfig]`](/reference/graphql/2-4-8/types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -401,7 +401,7 @@ query availableStores($useCurrentGroup: Boolean) { ##### Variables ```json -{"useCurrentGroup": true} +{"useCurrentGroup": false} ``` ##### Response @@ -411,197 +411,197 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "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": "abc123", - "allow_items": "xyz789", + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "abc123", "allow_order": "xyz789", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, - "base_currency_code": "xyz789", + "autocomplete_on_storefront": true, + "base_currency_code": "abc123", "base_link_url": "xyz789", "base_media_url": "abc123", "base_static_url": "xyz789", "base_url": "xyz789", - "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": false, - "braintree_3dsecure_specificcountry": "abc123", + "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_always_request_3ds": true, + "braintree_3dsecure_specificcountry": "xyz789", "braintree_3dsecure_threshold_amount": "xyz789", - "braintree_3dsecure_verify_3dsecure": false, + "braintree_3dsecure_verify_3dsecure": true, "braintree_ach_direct_debit_vault_active": false, "braintree_applepay_merchant_name": "abc123", - "braintree_applepay_vault_active": true, + "braintree_applepay_vault_active": false, "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": true, + "braintree_cc_vault_cvv": false, "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "xyz789", + "braintree_googlepay_btn_color": "abc123", "braintree_googlepay_cctypes": "xyz789", "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": "abc123", - "braintree_local_payment_redirect_on_fail": "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_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": 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": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_show": false, + "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", + "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123", + "braintree_paypal_button_location_cart_type_messaging_show": true, "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789", "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", "braintree_paypal_button_location_cart_type_paylater_label": "abc123", - "braintree_paypal_button_location_cart_type_paylater_shape": "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_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_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_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": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_show": false, + "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123", + "braintree_paypal_button_location_checkout_type_messaging_show": true, "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", + "braintree_paypal_button_location_checkout_type_paylater_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_paypal_color": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_label": "abc123", + "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": true, + "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": 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_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": "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": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_color": "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": "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_shape": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_show": false, "braintree_paypal_button_location_productpage_type_paypal_color": "abc123", "braintree_paypal_button_location_productpage_type_paypal_label": "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": true, + "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": false, "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": false, - "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 987, + "braintree_paypal_vault_active": true, + "cart_expires_in_days": 123, + "cart_gift_wrapping": "xyz789", + "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", - "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_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_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_send_check_to": "abc123", + "check_money_order_sort_order": 987, "check_money_order_title": "abc123", - "cms_home_page": "abc123", - "cms_no_cookies": "xyz789", + "cms_home_page": "xyz789", + "cms_no_cookies": "abc123", "cms_no_route": "xyz789", "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", - "contact_enabled": true, + "configurable_thumbnail_source": "xyz789", + "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": "xyz789", - "default_description": "abc123", + "default_country": "abc123", + "default_description": "xyz789", "default_display_currency_code": "abc123", "default_keywords": "abc123", - "default_title": "xyz789", - "demonotice": 123, + "default_title": "abc123", + "demonotice": 987, "display_product_prices_in_catalog": 123, - "display_shipping_prices": 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, - "fixed_product_taxes_display_prices_in_product_lists": 987, - "fixed_product_taxes_display_prices_in_sales_modules": 987, + "fixed_product_taxes_display_prices_in_product_lists": 123, + "fixed_product_taxes_display_prices_in_sales_modules": 123, "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": false, + "fixed_product_taxes_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": false, - "front": "abc123", - "graphql_share_all_customer_groups": false, + "front": "xyz789", + "graphql_share_all_customer_groups": true, "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", + "head_shortcut_icon": "abc123", "header_logo_src": "xyz789", - "id": 123, + "id": 987, "is_checkout_agreements_enabled": true, "is_default_store": false, - "is_default_store_group": false, + "is_default_store_group": true, "is_guest_checkout_enabled": false, "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": true, + "is_one_page_checkout_enabled": false, "is_requisition_list_active": "xyz789", - "list_mode": "xyz789", - "list_per_page": 987, - "list_per_page_values": "abc123", + "list_mode": "abc123", + "list_per_page": 123, + "list_per_page_values": "xyz789", "locale": "abc123", - "logo_alt": "xyz789", + "logo_alt": "abc123", "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": "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": "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": "xyz789", + "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": "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, - "minicart_max_items": 123, + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": true, + "minicart_max_items": 987, "minimum_password_length": "xyz789", - "newsletter_enabled": false, + "newsletter_enabled": true, "no_route": "xyz789", "optional_zip_countries": "xyz789", - "order_cancellation_enabled": false, + "order_cancellation_enabled": true, "order_cancellation_reasons": [ CancellationReason ], - "orders_invoices_credit_memos_display_full_summary": false, - "orders_invoices_credit_memos_display_grandtotal": true, - "orders_invoices_credit_memos_display_price": 123, + "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": 123, - "orders_invoices_credit_memos_display_subtotal": 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", @@ -609,33 +609,33 @@ query availableStores($useCurrentGroup: Boolean) { "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "abc123", "product_url_suffix": "xyz789", - "quickorder_active": false, - "required_character_classes_number": "abc123", - "returns_enabled": "abc123", + "quickorder_active": true, + "required_character_classes_number": "xyz789", + "returns_enabled": "xyz789", "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": "abc123", - "sales_printed_card": "abc123", - "secure_base_link_url": "xyz789", - "secure_base_media_url": "abc123", + "sales_printed_card": "xyz789", + "secure_base_link_url": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", - "secure_base_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "share_all_catalog_rules": false, - "share_all_sales_rule": false, - "share_applied_catalog_rules": false, - "share_applied_sales_rule": false, - "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": false, + "share_all_sales_rule": true, + "share_applied_catalog_rules": true, + "share_applied_sales_rule": true, + "shopping_cart_display_full_summary": false, + "shopping_cart_display_grand_total": true, "shopping_cart_display_price": 987, "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, - "show_cms_breadcrumbs": 123, + "shopping_cart_display_zero_tax": true, + "show_cms_breadcrumbs": 987, "store_code": "4", - "store_group_code": 4, + "store_group_code": "4", "store_group_name": "xyz789", "store_name": "abc123", "store_sort_order": 987, @@ -644,17 +644,17 @@ query availableStores($useCurrentGroup: Boolean) { "title_separator": "xyz789", "title_suffix": "xyz789", "use_store_in_url": true, - "website_code": "4", - "website_id": 123, - "website_name": "abc123", + "website_code": 4, + "website_id": 987, + "website_name": "xyz789", "weight_unit": "xyz789", "welcome": "xyz789", - "zero_subtotal_enable_for_specific_countries": false, + "zero_subtotal_enable_for_specific_countries": true, "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "xyz789", + "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_sort_order": 123, "zero_subtotal_title": "abc123" } ] @@ -668,13 +668,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](types-c-e.md#cart) +**Response:** [`Cart`](/reference/graphql/2-4-8/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -744,7 +744,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` ##### Response @@ -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 } } } @@ -788,15 +788,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](types-c-e.md#categoryresult) +**Response:** [`CategoryResult`](/reference/graphql/2-4-8/types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/2-4-8/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -858,13 +858,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](types-c-e.md#categorytree) +**Response:** [`CategoryTree`](/reference/graphql/2-4-8/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -925,7 +925,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response @@ -935,42 +935,42 @@ query category($id: Int) { "data": { "category": { "automatic_sorting": "abc123", - "available_sort_by": ["abc123"], + "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", + "created_at": "abc123", "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", - "description": "xyz789", + "default_sort_by": "xyz789", + "description": "abc123", "display_mode": "xyz789", - "filter_price_range": 123.45, - "id": 123, + "filter_price_range": 987.65, + "id": 987, "image": "xyz789", "include_in_menu": 987, - "is_anchor": 123, + "is_anchor": 987, "landing_page": 987, "level": 987, "meta_description": "abc123", - "meta_keywords": "xyz789", - "meta_title": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", "name": "xyz789", - "path": "abc123", + "path": "xyz789", "path_in_store": "abc123", - "position": 123, + "position": 987, "product_count": 123, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "xyz789", "staged": false, "type": "CMS_PAGE", "uid": 4, - "updated_at": "abc123", + "updated_at": "xyz789", "url_key": "xyz789", "url_path": "xyz789", - "url_suffix": "xyz789" + "url_suffix": "abc123" } } } @@ -986,15 +986,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) +**Response:** [`[CategoryTree]`](/reference/graphql/2-4-8/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/2-4-8/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -1080,38 +1080,38 @@ query categoryList( "automatic_sorting": "xyz789", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", + "canonical_url": "xyz789", "children": [CategoryTree], "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "abc123", "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", + "default_sort_by": "xyz789", "description": "abc123", - "display_mode": "abc123", - "filter_price_range": 123.45, - "id": 123, - "image": "xyz789", + "display_mode": "xyz789", + "filter_price_range": 987.65, + "id": 987, + "image": "abc123", "include_in_menu": 987, - "is_anchor": 987, + "is_anchor": 123, "landing_page": 123, - "level": 123, + "level": 987, "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "abc123", "name": "xyz789", "path": "abc123", "path_in_store": "abc123", "position": 987, "product_count": 987, "products": CategoryProducts, - "redirect_code": 123, + "redirect_code": 987, "relative_url": "abc123", "staged": true, "type": "CMS_PAGE", - "uid": "4", + "uid": 4, "updated_at": "xyz789", - "url_key": "abc123", + "url_key": "xyz789", "url_path": "xyz789", "url_suffix": "abc123" } @@ -1126,7 +1126,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](/reference/graphql/2-4-8/types-c-e.md#checkoutagreement) #### Example @@ -1155,7 +1155,7 @@ query checkoutAgreements { { "agreement_id": 123, "checkbox_text": "abc123", - "content": "abc123", + "content": "xyz789", "content_height": "abc123", "is_html": false, "mode": "AUTO", @@ -1172,13 +1172,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) +**Response:** [`CmsBlocks`](/reference/graphql/2-4-8/types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -1197,7 +1197,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["abc123"]} +{"identifiers": ["xyz789"]} ``` ##### Response @@ -1212,14 +1212,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](types-c-e.md#cmspage) +**Response:** [`CmsPage`](/reference/graphql/2-4-8/types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -1253,7 +1253,7 @@ query cmsPage( ##### Variables ```json -{"id": 987, "identifier": "abc123"} +{"id": 123, "identifier": "abc123"} ``` ##### Response @@ -1265,12 +1265,12 @@ query cmsPage( "content": "abc123", "content_heading": "abc123", "identifier": "xyz789", - "meta_description": "abc123", - "meta_keywords": "xyz789", + "meta_description": "xyz789", + "meta_keywords": "abc123", "meta_title": "xyz789", - "page_layout": "xyz789", + "page_layout": "abc123", "redirect_code": 987, - "relative_url": "xyz789", + "relative_url": "abc123", "title": "xyz789", "type": "CMS_PAGE", "url_key": "xyz789" @@ -1285,7 +1285,7 @@ query cmsPage( Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](types-c-e.md#company) +**Response:** [`Company`](/reference/graphql/2-4-8/types-c-e.md#company) #### Example @@ -1352,11 +1352,11 @@ query company { "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "abc123", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "xyz789", - "payment_methods": ["abc123"], + "name": "abc123", + "payment_methods": ["xyz789"], "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, @@ -1377,13 +1377,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/2-4-8/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1407,7 +1407,7 @@ query compareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -1417,7 +1417,7 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -1431,7 +1431,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](types-c-e.md#country) +**Response:** [`[Country]`](/reference/graphql/2-4-8/types-c-e.md#country) #### Example @@ -1460,10 +1460,10 @@ query countries { "countries": [ { "available_regions": [Region], - "full_name_english": "abc123", + "full_name_english": "xyz789", "full_name_locale": "abc123", - "id": "xyz789", - "three_letter_abbreviation": "xyz789", + "id": "abc123", + "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" } ] @@ -1477,13 +1477,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](types-c-e.md#country) +**Response:** [`Country`](/reference/graphql/2-4-8/types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](types-q-s.md#string) | | +| `id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -1507,7 +1507,7 @@ query country($id: String) { ##### Variables ```json -{"id": "abc123"} +{"id": "xyz789"} ``` ##### Response @@ -1517,11 +1517,11 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "xyz789", + "full_name_english": "abc123", "full_name_locale": "xyz789", "id": "abc123", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } } } @@ -1533,7 +1533,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](types-c-e.md#currency) +**Response:** [`Currency`](/reference/graphql/2-4-8/types-c-e.md#currency) #### Example @@ -1563,14 +1563,14 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "abc123" + "xyz789" ], - "base_currency_code": "abc123", - "base_currency_symbol": "abc123", + "base_currency_code": "xyz789", + "base_currency_symbol": "xyz789", "default_display_currecy_code": "xyz789", - "default_display_currecy_symbol": "xyz789", + "default_display_currecy_symbol": "abc123", "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "xyz789", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } } @@ -1587,13 +1587,13 @@ Use `customAttributeMetadataV2` query instead. Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](/reference/graphql/2-4-8/types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](/reference/graphql/2-4-8/types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1631,13 +1631,13 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](/reference/graphql/2-4-8/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](/reference/graphql/2-4-8/types-a-b.md#attributeinput) | | #### Example @@ -1681,7 +1681,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/2-4-8/types-c-e.md#customer) #### Example @@ -1807,24 +1807,24 @@ query customer { "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "abc123", + "default_shipping": "xyz789", "dob": "abc123", "email": "abc123", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroup, "group_id": 123, "id": 123, - "is_subscribed": true, - "job_title": "abc123", + "is_subscribed": false, + "job_title": "xyz789", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -1843,7 +1843,7 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, "telephone": "abc123", @@ -1861,7 +1861,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) #### Example @@ -1944,12 +1944,12 @@ query customerCart { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": false, + "id": 4, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, @@ -1957,7 +1957,7 @@ query customerCart { "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1969,7 +1969,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](/reference/graphql/2-4-8/types-c-e.md#customerdownloadableproducts) #### Example @@ -2005,7 +2005,7 @@ query customerDownloadableProducts { Use the `customer` query instead. -**Response:** [`CustomerOrders`](types-c-e.md#customerorders) +**Response:** [`CustomerOrders`](/reference/graphql/2-4-8/types-c-e.md#customerorders) #### Example @@ -2032,10 +2032,10 @@ query customerOrders { { "data": { "customerOrders": { - "date_of_first_order": "xyz789", + "date_of_first_order": "abc123", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -2047,7 +2047,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](/reference/graphql/2-4-8/types-c-e.md#customerpaymenttokens) #### Example @@ -2079,15 +2079,15 @@ query customerPaymentTokens { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) +**Response:** [`DynamicBlocks!`](/reference/graphql/2-4-8/types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](/reference/graphql/2-4-8/types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -2133,7 +2133,7 @@ query dynamicBlocks( "dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -2145,13 +2145,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) +**Response:** [`HostedProUrl`](/reference/graphql/2-4-8/types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](/reference/graphql/2-4-8/types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -2177,7 +2177,7 @@ query getHostedProUrl($input: HostedProUrlInput!) { { "data": { "getHostedProUrl": { - "secure_form_url": "xyz789" + "secure_form_url": "abc123" } } } @@ -2189,13 +2189,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) +**Response:** [`PayflowLinkToken`](/reference/graphql/2-4-8/types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](/reference/graphql/2-4-8/types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2225,9 +2225,9 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "abc123", - "secure_token": "abc123", - "secure_token_id": "abc123" + "paypal_url": "xyz789", + "secure_token": "xyz789", + "secure_token_id": "xyz789" } } } @@ -2239,13 +2239,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](/reference/graphql/2-4-8/types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/2-4-8/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2297,14 +2297,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](/reference/graphql/2-4-8/types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | +| `cartId` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | PayPal order ID | #### Example @@ -2333,8 +2333,8 @@ query getPaymentOrder( ```json { - "cartId": "abc123", - "id": "abc123" + "cartId": "xyz789", + "id": "xyz789" } ``` @@ -2345,7 +2345,7 @@ query getPaymentOrder( "data": { "getPaymentOrder": { "id": "abc123", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, "status": "abc123" } @@ -2359,13 +2359,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](/reference/graphql/2-4-8/types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/2-4-8/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2403,7 +2403,7 @@ query getPaymentSDK($location: PaymentLocation!) { Retrieves the vault configuration -**Response:** [`VaultConfigOutput`](types-t-z.md#vaultconfigoutput) +**Response:** [`VaultConfigOutput`](/reference/graphql/2-4-8/types-t-z.md#vaultconfigoutput) #### Example @@ -2437,13 +2437,13 @@ query getVaultConfig { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/2-4-8/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/2-4-8/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -2487,13 +2487,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) +**Response:** [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -2531,7 +2531,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -2546,8 +2546,8 @@ query giftRegistry($giftRegistryUid: ID!) { ], "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "xyz789", + "message": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, @@ -2565,13 +2565,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-8/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The registrant's email. | #### Example @@ -2593,7 +2593,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2603,10 +2603,10 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "abc123", - "event_title": "abc123", - "gift_registry_uid": "4", - "location": "xyz789", + "event_date": "xyz789", + "event_title": "xyz789", + "gift_registry_uid": 4, + "location": "abc123", "name": "xyz789", "type": "xyz789" } @@ -2621,13 +2621,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-8/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -2649,7 +2649,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -2660,11 +2660,11 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "giftRegistryIdSearch": [ { "event_date": "xyz789", - "event_title": "abc123", - "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", - "type": "abc123" + "event_title": "xyz789", + "gift_registry_uid": 4, + "location": "xyz789", + "name": "abc123", + "type": "xyz789" } ] } @@ -2677,15 +2677,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/2-4-8/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | +| `firstName` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2716,8 +2716,8 @@ query giftRegistryTypeSearch( ```json { - "firstName": "abc123", - "lastName": "abc123", + "firstName": "xyz789", + "lastName": "xyz789", "giftRegistryTypeUid": 4 } ``` @@ -2729,12 +2729,12 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "abc123", "gift_registry_uid": "4", "location": "xyz789", - "name": "abc123", - "type": "abc123" + "name": "xyz789", + "type": "xyz789" } ] } @@ -2747,7 +2747,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) +**Response:** [`[GiftRegistryType]`](/reference/graphql/2-4-8/types-f-i.md#giftregistrytype) #### Example @@ -2789,13 +2789,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and billing last name. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/2-4-8/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderInformationInput!`](types-k-p.md#orderinformationinput) | | +| `input` - [`OrderInformationInput!`](/reference/graphql/2-4-8/types-k-p.md#orderinformationinput) | | #### Example @@ -2889,9 +2889,9 @@ query guestOrder($input: OrderInformationInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], - "created_at": "abc123", + "created_at": "xyz789", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, "email": "abc123", @@ -2902,13 +2902,13 @@ query guestOrder($input: OrderInformationInput!) { "id": 4, "increment_id": "abc123", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", "order_date": "abc123", "order_number": "abc123", - "order_status_change_date": "xyz789", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, @@ -2916,7 +2916,7 @@ query guestOrder($input: OrderInformationInput!) { "shipping_address": OrderAddress, "shipping_method": "xyz789", "status": "xyz789", - "token": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -2929,13 +2929,13 @@ query guestOrder($input: OrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/2-4-8/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](/reference/graphql/2-4-8/types-k-p.md#ordertokeninput) | | #### Example @@ -3034,12 +3034,12 @@ query guestOrderByToken($input: OrderTokenInput!) { "created_at": "xyz789", "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, + "id": "4", "increment_id": "xyz789", "invoices": [Invoice], "is_virtual": false, @@ -3047,16 +3047,16 @@ query guestOrderByToken($input: OrderTokenInput!) { "items_eligible_for_return": [OrderItemInterface], "number": "abc123", "order_date": "xyz789", - "order_number": "abc123", + "order_number": "xyz789", "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": "xyz789", + "shipping_method": "abc123", "status": "xyz789", - "token": "xyz789", + "token": "abc123", "total": OrderTotal } } @@ -3069,13 +3069,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](/reference/graphql/2-4-8/types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -3092,13 +3092,13 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} ``` @@ -3107,13 +3107,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](/reference/graphql/2-4-8/types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -3136,7 +3136,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} ``` @@ -3145,13 +3145,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](/reference/graphql/2-4-8/types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](types-q-s.md#string) | | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -3183,13 +3183,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](/reference/graphql/2-4-8/types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -3206,7 +3206,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3221,13 +3221,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](/reference/graphql/2-4-8/types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to check. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address to check. | #### Example @@ -3244,13 +3244,13 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": false}}} +{"data": {"isEmailAvailable": {"is_email_available": true}}} ``` @@ -3259,13 +3259,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) +**Response:** [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -3316,7 +3316,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -3331,7 +3331,7 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "email": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, @@ -3357,13 +3357,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](types-f-i.md#id) | | +| `templateId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | | #### Example @@ -3423,12 +3423,12 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -3440,8 +3440,8 @@ query negotiableQuoteTemplate($templateId: ID!) { NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 987.65 + "template_id": "4", + "total_quantity": 123.45 } } } @@ -3453,16 +3453,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -3515,7 +3515,7 @@ query negotiableQuoteTemplates( "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -3527,16 +3527,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3601,18 +3601,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) +**Response:** [`PickupLocations`](/reference/graphql/2-4-8/types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](/reference/graphql/2-4-8/types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](/reference/graphql/2-4-8/types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](/reference/graphql/2-4-8/types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](/reference/graphql/2-4-8/types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3667,7 +3667,7 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -3679,7 +3679,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](/reference/graphql/2-4-8/types-k-p.md#productreviewratingsmetadata) #### Example @@ -3713,17 +3713,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](types-k-p.md#products) +**Response:** [`Products`](/reference/graphql/2-4-8/types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](/reference/graphql/2-4-8/types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](/reference/graphql/2-4-8/types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -3771,7 +3771,7 @@ query products( ```json { - "search": "xyz789", + "search": "abc123", "filter": ProductAttributeFilterInput, "pageSize": 20, "currentPage": 1, @@ -3791,7 +3791,7 @@ query products( "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 123 + "total_count": 987 } } } @@ -3801,13 +3801,13 @@ query products( ### recaptchaFormConfig -**Response:** [`ReCaptchaConfigOutput`](types-q-s.md#recaptchaconfigoutput) +**Response:** [`ReCaptchaConfigOutput`](/reference/graphql/2-4-8/types-q-s.md#recaptchaconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `formType` - [`ReCaptchaFormEnum!`](types-q-s.md#recaptchaformenum) | | +| `formType` - [`ReCaptchaFormEnum!`](/reference/graphql/2-4-8/types-q-s.md#recaptchaformenum) | | #### Example @@ -3837,7 +3837,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } } } @@ -3849,7 +3849,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](/reference/graphql/2-4-8/types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3876,13 +3876,13 @@ query recaptchaV3Config { { "data": { "recaptchaV3Config": { - "badge_position": "xyz789", + "badge_position": "abc123", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], "is_enabled": false, "language_code": "xyz789", - "minimum_score": 123.45, - "theme": "abc123", + "minimum_score": 987.65, + "theme": "xyz789", "website_key": "abc123" } } @@ -3895,13 +3895,13 @@ query recaptchaV3Config { Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) +**Response:** [`RoutableInterface`](/reference/graphql/2-4-8/types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3920,7 +3920,7 @@ query route($url: String!) { ##### Variables ```json -{"url": "xyz789"} +{"url": "abc123"} ``` ##### Response @@ -3929,7 +3929,7 @@ query route($url: String!) { { "data": { "route": { - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -3943,7 +3943,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](types-q-s.md#storeconfig) +**Response:** [`StoreConfig`](/reference/graphql/2-4-8/types-q-s.md#storeconfig) #### Example @@ -4211,107 +4211,107 @@ query storeConfig { { "data": { "storeConfig": { - "absolute_footer": "abc123", - "allow_gift_receipt": "xyz789", + "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_gift_wrapping_on_order_items": "abc123", + "allow_guests_to_write_product_reviews": "abc123", "allow_items": "xyz789", - "allow_order": "xyz789", - "allow_printed_card": "xyz789", + "allow_order": "abc123", + "allow_printed_card": "abc123", "autocomplete_on_storefront": false, "base_currency_code": "xyz789", "base_link_url": "abc123", "base_media_url": "xyz789", - "base_static_url": "abc123", + "base_static_url": "xyz789", "base_url": "abc123", "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": true, + "braintree_3dsecure_always_request_3ds": false, "braintree_3dsecure_specificcountry": "abc123", - "braintree_3dsecure_threshold_amount": "abc123", - "braintree_3dsecure_verify_3dsecure": true, + "braintree_3dsecure_threshold_amount": "xyz789", + "braintree_3dsecure_verify_3dsecure": false, "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_cc_vault_cvv": false, + "braintree_environment": "xyz789", "braintree_googlepay_btn_color": "abc123", - "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_cctypes": "xyz789", "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": true, + "braintree_googlepay_vault_active": false, "braintree_local_payment_allowed_methods": "xyz789", "braintree_local_payment_fallback_button_text": "xyz789", - "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": "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": "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_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": "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_shape": "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": "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": true, + "braintree_paypal_button_location_checkout_type_credit_show": false, "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_show": true, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", + "braintree_paypal_button_location_checkout_type_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_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": "abc123", + "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": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_show": false, "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", - "braintree_paypal_button_location_productpage_type_credit_label": "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": 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": "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_logo_position": "abc123", + "braintree_paypal_button_location_productpage_type_messaging_show": false, + "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_color": "abc123", "braintree_paypal_button_location_productpage_type_paylater_label": "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_paylater_show": true, "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_shape": "abc123", "braintree_paypal_button_location_productpage_type_paypal_show": false, - "braintree_paypal_credit_uk_merchant_name": "abc123", + "braintree_paypal_credit_uk_merchant_name": "xyz789", "braintree_paypal_display_on_shopping_cart": false, - "braintree_paypal_merchant_country": "xyz789", - "braintree_paypal_merchant_name_override": "xyz789", - "braintree_paypal_require_billing_address": false, + "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": false, - "cart_expires_in_days": 123, + "cart_expires_in_days": 987, "cart_gift_wrapping": "xyz789", "cart_printed_card": "abc123", "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", + "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": "xyz789", "check_money_order_new_order_status": "xyz789", @@ -4321,139 +4321,139 @@ query storeConfig { "check_money_order_title": "xyz789", "cms_home_page": "xyz789", "cms_no_cookies": "abc123", - "cms_no_route": "xyz789", - "code": "xyz789", + "cms_no_route": "abc123", + "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", + "configurable_thumbnail_source": "xyz789", "contact_enabled": true, - "copyright": "abc123", + "copyright": "xyz789", "countries_with_required_region": "abc123", "create_account_confirmation": false, - "customer_access_token_lifetime": 987.65, + "customer_access_token_lifetime": 123.45, "default_country": "xyz789", "default_description": "abc123", "default_display_currency_code": "xyz789", - "default_keywords": "abc123", - "default_title": "xyz789", - "demonotice": 123, + "default_keywords": "xyz789", + "default_title": "abc123", + "demonotice": 987, "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": false, - "enable_multiple_wishlists": "abc123", + "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_emails": 123, + "fixed_product_taxes_display_prices_in_product_lists": 987, "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": false, + "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": false, - "graphql_share_customer_group": false, + "front": "xyz789", + "graphql_share_all_customer_groups": true, + "graphql_share_customer_group": true, "grid_per_page": 987, - "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", + "head_shortcut_icon": "abc123", + "header_logo_src": "abc123", "id": 123, - "is_checkout_agreements_enabled": true, + "is_checkout_agreements_enabled": false, "is_default_store": true, - "is_default_store_group": false, - "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": false, + "is_default_store_group": true, + "is_guest_checkout_enabled": true, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": false, "is_requisition_list_active": "abc123", - "list_mode": "abc123", + "list_mode": "xyz789", "list_per_page": 987, - "list_per_page_values": "xyz789", + "list_per_page_values": "abc123", "locale": "xyz789", - "logo_alt": "xyz789", - "logo_height": 987, + "logo_alt": "abc123", + "logo_height": 123, "logo_width": 987, "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "xyz789", + "magento_reward_general_is_enabled_on_front": "abc123", "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": "xyz789", + "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "abc123", "magento_reward_points_order": "xyz789", "magento_reward_points_register": "abc123", - "magento_reward_points_review": "abc123", + "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 987, - "maximum_number_of_wishlists": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "abc123", "minicart_display": true, - "minicart_max_items": 123, - "minimum_password_length": "xyz789", - "newsletter_enabled": true, + "minicart_max_items": 987, + "minimum_password_length": "abc123", + "newsletter_enabled": false, "no_route": "abc123", "optional_zip_countries": "abc123", "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], - "orders_invoices_credit_memos_display_full_summary": 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, + "orders_invoices_credit_memos_display_price": 123, + "orders_invoices_credit_memos_display_shipping_amount": 123, + "orders_invoices_credit_memos_display_subtotal": 987, + "orders_invoices_credit_memos_display_zero_tax": false, "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "xyz789", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", - "product_url_suffix": "xyz789", - "quickorder_active": true, + "product_reviews_enabled": "abc123", + "product_url_suffix": "abc123", + "quickorder_active": false, "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": "abc123", - "sales_printed_card": "xyz789", - "secure_base_link_url": "xyz789", + "sales_printed_card": "abc123", + "secure_base_link_url": "abc123", "secure_base_media_url": "xyz789", - "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_static_url": "abc123", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, "share_all_catalog_rules": true, - "share_all_sales_rule": false, - "share_applied_catalog_rules": true, - "share_applied_sales_rule": false, + "share_all_sales_rule": true, + "share_applied_catalog_rules": false, + "share_applied_sales_rule": true, "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": 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_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, - "show_cms_breadcrumbs": 123, + "show_cms_breadcrumbs": 987, "store_code": 4, "store_group_code": "4", - "store_group_name": "xyz789", + "store_group_name": "abc123", "store_name": "abc123", "store_sort_order": 123, "timezone": "xyz789", - "title_prefix": "xyz789", - "title_separator": "abc123", - "title_suffix": "xyz789", + "title_prefix": "abc123", + "title_separator": "xyz789", + "title_suffix": "abc123", "use_store_in_url": true, "website_code": "4", - "website_id": 123, + "website_id": 987, "website_name": "abc123", "weight_unit": "xyz789", - "welcome": "abc123", + "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", + "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" + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 987, + "zero_subtotal_title": "abc123" } } } @@ -4469,13 +4469,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](types-c-e.md#entityurl) +**Response:** [`EntityUrl`](/reference/graphql/2-4-8/types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4497,7 +4497,7 @@ query urlResolver($url: String!) { ##### Variables ```json -{"url": "xyz789"} +{"url": "abc123"} ``` ##### Response @@ -4509,7 +4509,7 @@ query urlResolver($url: String!) { "canonical_url": "abc123", "entity_uid": "4", "id": 987, - "redirectCode": 987, + "redirectCode": 123, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -4527,7 +4527,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) +**Response:** [`WishlistOutput`](/reference/graphql/2-4-8/types-t-z.md#wishlistoutput) #### Example @@ -4554,9 +4554,9 @@ query wishlist { "data": { "wishlist": { "items": [WishlistItem], - "items_count": 987, - "name": "abc123", - "sharing_code": "xyz789", + "items_count": 123, + "name": "xyz789", + "sharing_code": "abc123", "updated_at": "abc123" } } 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 index d37e9b545..7b9f716e4 100644 --- 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 @@ -8,12 +8,12 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -26,14 +26,14 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [BundleProductCartItemInput] } ``` @@ -48,7 +48,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -66,8 +66,8 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](/reference/graphql/2-4-8/types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example @@ -88,7 +88,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -104,8 +104,8 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](/reference/graphql/2-4-8/types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example @@ -126,7 +126,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -144,10 +144,10 @@ Defines a new registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-8/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the registrant. | #### Example @@ -156,8 +156,8 @@ Defines a new registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", - "firstname": "abc123", + "email": "abc123", + "firstname": "xyz789", "lastname": "xyz789" } ``` @@ -172,7 +172,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -190,8 +190,8 @@ Contains details about the cart after adding products to it. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | -| `user_errors` - [`[Error]!`](types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](/reference/graphql/2-4-8/types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | #### Example @@ -212,13 +212,13 @@ Contains products to add to an existing compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": [4], "uid": 4} +{"products": [4], "uid": "4"} ``` @@ -231,7 +231,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -249,8 +249,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -271,14 +271,14 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { - "comment": "xyz789", + "comment": "abc123", "purchase_order_uid": "4" } ``` @@ -293,7 +293,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](/reference/graphql/2-4-8/types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -311,8 +311,8 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example @@ -335,7 +335,7 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A description of the error. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example @@ -377,7 +377,7 @@ Output of the request to add items in a requisition list to the cart. | 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`](types-c-e.md#cart) | The cart after adding requisition list items. | +| `cart` - [`Cart`](/reference/graphql/2-4-8/types-c-e.md#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 @@ -388,7 +388,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } ``` @@ -402,8 +402,8 @@ Defines a return comment. | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `comment_text` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -421,7 +421,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | The modified return. | +| `return` - [`Return`](/reference/graphql/2-4-8/types-q-s.md#return) | The modified return. | #### Example @@ -439,17 +439,17 @@ Defines tracking information to be added to the return. | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | +| `carrier_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { - "carrier_uid": "4", - "return_uid": 4, - "tracking_number": "xyz789" + "carrier_uid": 4, + "return_uid": "4", + "tracking_number": "abc123" } ``` @@ -463,8 +463,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](/reference/graphql/2-4-8/types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](/reference/graphql/2-4-8/types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -485,8 +485,8 @@ Defines the simple and group products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](/reference/graphql/2-4-8/types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example @@ -507,7 +507,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -525,14 +525,14 @@ Defines the virtual products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](/reference/graphql/2-4-8/types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [VirtualProductCartItemInput] } ``` @@ -547,7 +547,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -565,9 +565,9 @@ Contains the resultant wish list and any error information. | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](/reference/graphql/2-4-8/types-t-z.md#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!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -591,21 +591,21 @@ Contains information for each filterable option (such as price, category `UID`, | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | -| `label` - [`String`](types-q-s.md#string) | The aggregation display name. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The aggregation display name. | | `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example ```json { - "attribute_code": "xyz789", - "count": 987, + "attribute_code": "abc123", + "count": 123, "label": "abc123", "options": [AggregationOption], - "position": 987 + "position": 123 } ``` @@ -619,17 +619,17 @@ An implementation of `AggregationOptionInterface`. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example ```json { - "count": 987, + "count": 123, "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -643,9 +643,9 @@ Defines aggregation option fields. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -678,7 +678,7 @@ Filter category aggregations in layered navigation. #### Example ```json -{"includeDirectChildrenOnly": false} +{"includeDirectChildrenOnly": true} ``` @@ -708,26 +708,26 @@ An input object that specifies the filters used in product aggregations. | Field Name | Description | |------------|-------------| | `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `payment_intent` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-8/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": ButtonStyles, - "code": "abc123", - "is_visible": true, - "payment_intent": "abc123", + "code": "xyz789", + "is_visible": false, + "payment_intent": "xyz789", "payment_source": "abc123", "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "abc123" + "sort_order": "xyz789", + "title": "xyz789" } ``` @@ -741,17 +741,17 @@ Apple Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | PayPal order ID | #### Example ```json { - "payment_source": "xyz789", - "payments_order_id": "abc123", - "paypal_order_id": "abc123" + "payment_source": "abc123", + "payments_order_id": "xyz789", + "paypal_order_id": "xyz789" } ``` @@ -765,7 +765,7 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example @@ -783,19 +783,19 @@ Contains an applied gift card with applied and remaining balance. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `applied_balance` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "applied_balance": Money, - "code": "abc123", + "code": "xyz789", "current_balance": Money, - "expiration_date": "xyz789" + "expiration_date": "abc123" } ``` @@ -809,8 +809,8 @@ Contains the applied and current balances. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](types-k-p.md#money) | The current balance remaining on store credit. | +| `applied_balance` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#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 @@ -833,14 +833,14 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A valid coupon code. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "coupon_code": "xyz789" } ``` @@ -855,7 +855,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -892,8 +892,8 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](types-q-s.md#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -901,7 +901,7 @@ Apply coupons to the cart. ```json { "cart_id": "abc123", - "coupon_codes": ["xyz789"], + "coupon_codes": ["abc123"], "type": "APPEND" } ``` @@ -916,8 +916,8 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example @@ -938,7 +938,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -956,15 +956,15 @@ Contains applied gift cards with gift card code and amount. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](types-k-p.md#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](types-q-s.md#string) | The gift card account code. | +| `applied_balance` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The gift card account code. | #### Example ```json { "applied_balance": Money, - "code": "xyz789" + "code": "abc123" } ``` @@ -978,7 +978,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -996,12 +996,12 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -1014,7 +1014,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -1032,13 +1032,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | Input Field | Description | |-------------|-------------| -| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | -| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| `radius` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 987, "search_term": "abc123"} +{"radius": 123, "search_term": "abc123"} ``` @@ -1051,7 +1051,7 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](/reference/graphql/2-4-8/types-c-e.md#comparelist) | The contents of the customer's compare list. | | `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | #### Example @@ -1070,12 +1070,12 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The data type of the attribute. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `attribute_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](/reference/graphql/2-4-8/types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example @@ -1084,7 +1084,7 @@ Contains details about the attribute, including the code and type. "attribute_code": "abc123", "attribute_options": [AttributeOption], "attribute_type": "xyz789", - "entity_type": "xyz789", + "entity_type": "abc123", "input_type": "abc123", "storefront_properties": StorefrontProperties } @@ -1139,18 +1139,18 @@ An input object that specifies the filters used for attributes. ```json { - "is_comparable": false, + "is_comparable": true, "is_filterable": false, "is_filterable_in_search": false, "is_html_allowed_on_front": false, - "is_searchable": false, - "is_used_for_customer_segment": true, + "is_searchable": true, + "is_used_for_customer_segment": false, "is_used_for_price_rules": false, - "is_used_for_promo_rules": true, - "is_visible_in_advanced_search": false, - "is_visible_on_front": true, - "is_wysiwyg_enabled": false, - "used_in_product_listing": true + "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 } ``` @@ -1197,8 +1197,8 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `attribute_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of entity that defines the attribute. | #### Example @@ -1219,12 +1219,12 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute option value. | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -1237,15 +1237,15 @@ Base EAV implementation of CustomAttributeMetadataInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Default attribute value. | | `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/2-4-8/types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example @@ -1254,10 +1254,10 @@ Base EAV implementation of CustomAttributeMetadataInterface. "code": "4", "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_required": false, - "is_unique": true, + "is_required": true, + "is_unique": false, "label": "abc123", "options": [CustomAttributeOptionInterface] } @@ -1273,14 +1273,14 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "type": "ENTITY_NOT_FOUND" } ``` @@ -1316,15 +1316,15 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute option value. | #### Example ```json { "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -1339,8 +1339,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| | `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute option value. | #### Example @@ -1348,7 +1348,7 @@ Base EAV implementation of CustomAttributeOptionInterface. { "is_default": true, "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1360,8 +1360,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute selected option value. | #### Example @@ -1380,8 +1380,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1393,8 +1393,8 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "label": "abc123", - "value": "xyz789" + "label": "xyz789", + "value": "abc123" } ``` @@ -1406,14 +1406,14 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example ```json { - "code": "4", + "code": 4, "selected_options": [AttributeSelectedOptionInterface] } ``` @@ -1426,16 +1426,13 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The attribute value. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute value. | #### Example ```json -{ - "code": "4", - "value": "xyz789" -} +{"code": 4, "value": "abc123"} ``` @@ -1448,17 +1445,17 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The code of the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The code of the attribute. | | `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "selected_options": [AttributeInputSelectedOption], - "value": "xyz789" + "value": "abc123" } ``` @@ -1470,7 +1467,7 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1496,7 +1493,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/2-4-8/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1518,7 +1515,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/2-4-8/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1539,13 +1536,13 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](/reference/graphql/2-4-8/types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Currency symbol, for example $. | #### Example ```json -{"code": "AFN", "symbol": "abc123"} +{"code": "AFN", "symbol": "xyz789"} ``` @@ -1558,17 +1555,17 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](types-q-s.md#string) | The payment method title. | +| `title` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method title. | #### Example ```json { "code": "abc123", - "is_deferred": false, - "title": "abc123" + "is_deferred": true, + "title": "xyz789" } ``` @@ -1582,16 +1579,16 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#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`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | -| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | -| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `base_amount` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1602,8 +1599,8 @@ Contains details about the possible shipping methods and carriers. "base_amount": Money, "carrier_code": "xyz789", "carrier_title": "xyz789", - "error_message": "abc123", - "method_code": "xyz789", + "error_message": "xyz789", + "method_code": "abc123", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -1638,8 +1635,8 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `address` - [`CartAddressInput`](/reference/graphql/2-4-8/types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -1648,8 +1645,8 @@ Defines the billing address. ```json { "address": CartAddressInput, - "customer_address_id": 123, - "same_as_shipping": true, + "customer_address_id": 987, + "same_as_shipping": false, "use_for_shipping": true } ``` @@ -1664,20 +1661,20 @@ The billing address information | Input Field | Description | |-------------|-------------| -| `address_line_1` - [`String`](types-q-s.md#string) | The first line of the address | -| `address_line_2` - [`String`](types-q-s.md#string) | The second line of the address | -| `city` - [`String`](types-q-s.md#string) | The city of the address | -| `country_code` - [`String!`](types-q-s.md#string) | The country of the address | -| `postal_code` - [`String`](types-q-s.md#string) | The postal code of the address | -| `region` - [`String`](types-q-s.md#string) | The region of the address | +| `address_line_1` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The first line of the address | +| `address_line_2` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The second line of the address | +| `city` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The city of the address | +| `country_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The country of the address | +| `postal_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The postal code of the address | +| `region` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The region of the address | #### Example ```json { - "address_line_1": "abc123", - "address_line_2": "abc123", - "city": "abc123", + "address_line_1": "xyz789", + "address_line_2": "xyz789", + "city": "xyz789", "country_code": "abc123", "postal_code": "xyz789", "region": "xyz789" @@ -1694,31 +1691,31 @@ Contains details about the billing address. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/2-4-8/types-c-e.md#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`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `customer_notes` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Id of the customer address. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](/reference/graphql/2-4-8/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_notes": "abc123", @@ -1728,13 +1725,13 @@ Contains details about the billing address. "lastname": "abc123", "middlename": "abc123", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", - "uid": "abc123", - "vat_id": "xyz789" + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", + "uid": "xyz789", + "vat_id": "abc123" } ``` @@ -1744,6 +1741,12 @@ Contains details about the billing address. The `Boolean` scalar type represents `true` or `false`. +#### Example + +```json +true +``` + ### BraintreeCcVaultInput @@ -1752,15 +1755,15 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | | -| `public_hash` - [`String!`](types-q-s.md#string) | | +| `device_data` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `public_hash` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example ```json { "device_data": "xyz789", - "public_hash": "xyz789" + "public_hash": "abc123" } ``` @@ -1772,9 +1775,9 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway. | +| `device_data` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-q-s.md#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | +| `payment_method_nonce` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | #### Example @@ -1794,14 +1797,14 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | | -| `public_hash` - [`String!`](types-q-s.md#string) | | +| `device_data` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `public_hash` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example ```json { - "device_data": "abc123", + "device_data": "xyz789", "public_hash": "xyz789" } ``` @@ -1816,12 +1819,12 @@ Contains details about an individual category that comprises a breadcrumb. | Field Name | Description | |------------|-------------| -| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](types-f-i.md#int) | The category level. | -| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | -| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | +| `category_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The category level. | +| `category_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL path of the category. | #### Example @@ -1829,8 +1832,8 @@ Contains details about an individual category that comprises a breadcrumb. { "category_id": 123, "category_level": 987, - "category_name": "abc123", - "category_uid": "4", + "category_name": "xyz789", + "category_uid": 4, "category_url_key": "abc123", "category_url_path": "abc123" } @@ -1846,24 +1849,24 @@ An implementation for bundle product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-8/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | | `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-8/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1876,16 +1879,16 @@ An implementation for bundle product cart items. "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", + "id": "abc123", + "is_available": false, + "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, + "quantity": 123.45, "uid": 4 } ``` @@ -1900,14 +1903,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-8/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | #### Example @@ -1915,11 +1918,11 @@ Defines bundle product options for `CreditMemoItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 } ``` @@ -1934,14 +1937,14 @@ Defines bundle product options for `InvoiceItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-8/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1953,8 +1956,8 @@ Defines bundle product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 + "product_sku": "xyz789", + "quantity_invoiced": 987.65 } ``` @@ -1968,29 +1971,29 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | | `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | -| `title` - [`String`](types-q-s.md#string) | The display name of the item. | -| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example ```json { - "option_id": 123, + "option_id": 987, "options": [BundleItemOption], "position": 123, "price_range": PriceRange, - "required": false, + "required": true, "sku": "abc123", "title": "xyz789", "type": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -2005,30 +2008,30 @@ Defines the characteristics that comprise a specific bundle item and its options | Field Name | Description | |------------|-------------| | `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](types-f-i.md#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": false, - "id": 123, - "is_default": true, + "can_change_quantity": true, + "id": 987, + "is_default": false, "label": "abc123", "position": 123, "price": 123.45, "price_type": "FIXED", "product": ProductInterface, - "qty": 987.65, + "qty": 123.45, "quantity": 987.65, "uid": "4" } @@ -2044,15 +2047,15 @@ Defines the input for a bundle option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array with the chosen value of the option. | #### Example ```json { - "id": 987, + "id": 123, "quantity": 123.45, "value": ["abc123"] } @@ -2068,30 +2071,30 @@ Defines bundle product options for `OrderItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-8/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#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]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/2-4-8/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the order item. | #### Example @@ -2099,25 +2102,25 @@ Defines bundle product options for `OrderItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "abc123", + "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "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, + "product_type": "abc123", + "product_url_key": "xyz789", + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" @@ -2134,98 +2137,98 @@ Defines basic features of a bundle product and contains multiple BundleItems. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `activity` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](/reference/graphql/2-4-8/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-8/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `eco_collection` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates whether the product can be returned. | | `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-8/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-8/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](/reference/graphql/2-4-8/types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-8/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](/reference/graphql/2-4-8/types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-8/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](/reference/graphql/2-4-8/types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](/reference/graphql/2-4-8/types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-8/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-8/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-8/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2235,9 +2238,9 @@ Defines basic features of a bundle product and contains multiple BundleItems. "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "abc123", - "collar": "abc123", + "category_gear": "xyz789", + "climate": "xyz789", + "collar": "xyz789", "color": 123, "country_of_manufacture": "abc123", "created_at": "xyz789", @@ -2247,35 +2250,35 @@ Defines basic features of a bundle product and contains multiple BundleItems. "dynamic_price": false, "dynamic_sku": false, "dynamic_weight": false, - "eco_collection": 987, + "eco_collection": 123, "erin_recommends": 987, "features_bags": "abc123", - "format": 123, - "gender": "xyz789", - "gift_message_available": true, + "format": 987, + "gender": "abc123", + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "xyz789", "items": [BundleItem], - "manufacturer": 987, - "material": "xyz789", - "max_sale_qty": 123.45, + "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": 987.65, - "name": "xyz789", + "min_sale_qty": 123.45, + "name": "abc123", "new": 123, "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", - "pattern": "abc123", + "pattern": "xyz789", "performance_fabric": 987, "price": ProductPrices, "price_details": PriceDetails, @@ -2283,46 +2286,46 @@ Defines basic features of a bundle product and contains multiple BundleItems. "price_tiers": [TierPrice], "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], - "purpose": 123, - "quantity": 987.65, + "purpose": 987, + "quantity": 123.45, "rating_summary": 123.45, "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], "sale": 987, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "size": 987, - "sku": "xyz789", - "sleeve": "abc123", + "size": 123, + "sku": "abc123", + "sleeve": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, + "special_from_date": "xyz789", + "special_price": 987.65, "special_to_date": "abc123", - "staged": false, + "staged": true, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "xyz789", + "style_bags": "abc123", "style_bottom": "abc123", - "style_general": "abc123", - "swatch_image": "xyz789", + "style_general": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", - "uid": "4", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -2337,8 +2340,8 @@ Defines a single bundle product. | 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]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-8/types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-8/types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -2360,11 +2363,11 @@ Contains details about bundle products added to a requisition list. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2374,7 +2377,7 @@ Contains details about bundle products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -2388,13 +2391,13 @@ Defines bundle product options for `ShipmentItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/2-4-8/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | #### Example @@ -2405,8 +2408,8 @@ Defines bundle product options for `ShipmentItemInterface`. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 123.45 + "product_sku": "abc123", + "quantity_shipped": 987.65 } ``` @@ -2420,19 +2423,19 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](/reference/graphql/2-4-8/types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "description": "xyz789", @@ -2450,11 +2453,11 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | -| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | -| `label` - [`String`](types-q-s.md#string) | The button label | -| `layout` - [`String`](types-q-s.md#string) | The button layout | -| `shape` - [`String`](types-q-s.md#string) | The button shape | +| `color` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The button color | +| `height` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The button label | +| `layout` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The button layout | +| `shape` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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 | @@ -2464,9 +2467,9 @@ Defines bundle product options for `WishlistItemInterface`. { "color": "abc123", "height": 123, - "label": "abc123", + "label": "xyz789", "layout": "xyz789", - "shape": "xyz789", + "shape": "abc123", "tagline": false, "use_default_height": false } diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md index 92f27014f..10bf8f214 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md @@ -8,15 +8,15 @@ Specifies the quote template id of the quote template to cancel | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `cancellation_comment` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "cancellation_comment": "abc123", - "template_id": "4" + "cancellation_comment": "xyz789", + "template_id": 4 } ``` @@ -29,14 +29,14 @@ Specifies the quote template id of the quote template to cancel | Field Name | Description | |------------|-------------| | `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" + "message": "xyz789" } ``` @@ -71,16 +71,13 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | +| `order_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Cancellation reason. | #### Example ```json -{ - "order_id": "4", - "reason": "abc123" -} +{"order_id": 4, "reason": "xyz789"} ``` @@ -93,7 +90,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | +| `error` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Error encountered while cancelling the order. | | `errorV2` - [`CancelOrderError`](#cancelordererror) | | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | @@ -115,12 +112,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](types-q-s.md#string) | | +| `description` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example ```json -{"description": "abc123"} +{"description": "xyz789"} ``` @@ -132,10 +129,10 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| | `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `name` - [`String`](types-q-s.md#string) | Name on the card | +| `card_expiry_month` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Name on the card | #### Example @@ -143,9 +140,9 @@ Contains the updated customer order and error message if any. { "bin_details": CardBin, "card_expiry_month": "abc123", - "card_expiry_year": "abc123", + "card_expiry_year": "xyz789", "last_digits": "abc123", - "name": "abc123" + "name": "xyz789" } ``` @@ -157,12 +154,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](types-q-s.md#string) | Card bin number | +| `bin` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "xyz789"} +{"bin": "abc123"} ``` @@ -175,8 +172,8 @@ The card payment source information | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](types-q-s.md#string) | The name on the cardholder | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](/reference/graphql/2-4-8/types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name on the cardholder | #### Example @@ -197,17 +194,17 @@ The card payment source information | Field Name | Description | |------------|-------------| -| `brand` - [`String`](types-q-s.md#string) | The brand of the card | -| `expiry` - [`String`](types-q-s.md#string) | The expiry of the card | -| `last_digits` - [`String`](types-q-s.md#string) | The last digits of the card | +| `brand` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The brand of the card | +| `expiry` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The expiry of the card | +| `last_digits` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The last digits of the card | #### Example ```json { - "brand": "xyz789", + "brand": "abc123", "expiry": "xyz789", - "last_digits": "xyz789" + "last_digits": "abc123" } ``` @@ -221,28 +218,28 @@ Contains the contents and other details about a guest or customer cart. | Field Name | Description | |------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart contains only virtual products. | +| `applied_coupon` - [`AppliedCoupon`](/reference/graphql/2-4-8/types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](/reference/graphql/2-4-8/types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](/reference/graphql/2-4-8/types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](/reference/graphql/2-4-8/types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](/reference/graphql/2-4-8/types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/2-4-8/types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](/reference/graphql/2-4-8/types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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!`](types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/2-4-8/types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](/reference/graphql/2-4-8/types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -265,11 +262,11 @@ Contains the contents and other details about a guest or customer cart. "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } ``` @@ -283,15 +280,15 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The country code. | -| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The country code. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display label for the country. | #### Example ```json { "code": "xyz789", - "label": "abc123" + "label": "xyz789" } ``` @@ -305,45 +302,45 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country_code": "abc123", "custom_attributes": [AttributeValueInput], "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "xyz789", "middlename": "abc123", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "xyz789", - "region": "abc123", - "region_id": 987, + "region": "xyz789", + "region_id": 123, "save_in_address_book": true, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "xyz789" + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "vat_id": "abc123" } ``` @@ -355,30 +352,30 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company specified for the billing or shipping address. | | `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Id of the customer address. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | | `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](types-q-s.md#string) | The unique id of the customer address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique id of the customer address. | +| `vat_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | -| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | +| [`ShippingCartAddress`](/reference/graphql/2-4-8/types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](/reference/graphql/2-4-8/types-a-b.md#billingcartaddress) | #### Example @@ -388,19 +385,19 @@ Defines the billing or shipping address to be applied to the cart. "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "fax": "xyz789", + "fax": "abc123", "firstname": "abc123", - "id": 987, + "id": 123, "lastname": "abc123", "middlename": "abc123", "postcode": "xyz789", "prefix": "abc123", "region": CartAddressRegion, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "abc123", - "vat_id": "abc123" + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": "xyz789", + "vat_id": "xyz789" } ``` @@ -414,9 +411,9 @@ Contains details about the region in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The state or province code. | -| `label` - [`String`](types-q-s.md#string) | The display label for the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The state or province code. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -424,7 +421,7 @@ Contains details about the region in a billing or shipping address. { "code": "xyz789", "label": "xyz789", - "region_id": 123 + "region_id": 987 } ``` @@ -438,15 +435,15 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the discount. | #### Example ```json { "amount": Money, - "label": ["xyz789"] + "label": ["abc123"] } ``` @@ -476,7 +473,7 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message | #### Example @@ -513,10 +510,10 @@ Defines an item to be added to the cart. | Input Field | Description | |-------------|-------------| | `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | +| `parent_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-8/types-f-i.md#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!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the product. | #### Example @@ -526,7 +523,7 @@ Defines an item to be added to the cart. "parent_sku": "abc123", "quantity": 987.65, "selected_options": ["4"], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -542,28 +539,28 @@ An interface for products in a cart. |------------|-------------| | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](types-q-s.md#simplecartitem) | -| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | +| [`SimpleCartItem`](/reference/graphql/2-4-8/types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](/reference/graphql/2-4-8/types-t-z.md#virtualcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | -| [`BundleCartItem`](types-a-b.md#bundlecartitem) | +| [`BundleCartItem`](/reference/graphql/2-4-8/types-a-b.md#bundlecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | +| [`GiftCardCartItem`](/reference/graphql/2-4-8/types-f-i.md#giftcardcartitem) | #### Example @@ -572,15 +569,15 @@ An interface for products in a cart. "discount": [Discount], "errors": [CartItemError], "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], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` @@ -595,17 +592,17 @@ Contains details about the price of the item, including taxes and discounts. | Field Name | Description | |------------|-------------| -| `catalog_discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | +| `catalog_discount` - [`ProductDiscount`](/reference/graphql/2-4-8/types-k-p.md#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]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | -| `original_item_price` - [`Money!`](types-k-p.md#money) | The value of the original unit price for the item, including discounts. | -| `original_row_total` - [`Money!`](types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | -| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/2-4-8/types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#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!`](/reference/graphql/2-4-8/types-k-p.md#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`](/reference/graphql/2-4-8/types-k-p.md#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!`](/reference/graphql/2-4-8/types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -635,13 +632,13 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `cart_item_id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart_item_id": 123, "quantity": 987.65} +{"cart_item_id": 123, "quantity": 123.45} ``` @@ -654,9 +651,9 @@ Contains details about the price of a selected customizable value. | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](types-f-i.md#float) | A price value. | +| `type` - [`PriceTypeEnum!`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | A price value. | #### Example @@ -664,7 +661,7 @@ Contains details about the price of a selected customizable value. { "type": "FIXED", "units": "abc123", - "value": 987.65 + "value": 123.45 } ``` @@ -678,12 +675,12 @@ A single item to be updated. | Input Field | Description | |-------------|-------------| -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | | `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/2-4-8/types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The new quantity of the item. | #### Example @@ -707,8 +704,8 @@ A single item to be updated. | Field Name | Description | |------------|-------------| | `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of returned cart items. | #### Example @@ -733,12 +730,12 @@ Contains details about the final price of items in the cart, including discount | `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`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | -| `grand_total_excluding_tax` - [`Money`](types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | -| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/2-4-8/types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -764,7 +761,7 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | Name of the cart price rule | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Name of the cart price rule | #### Example @@ -782,15 +779,15 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the tax. | #### Example ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -803,14 +800,14 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -870,29 +867,29 @@ Swatch attribute metadata. | Field Name | Description | |------------|-------------| | `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-8/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-8/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](/reference/graphql/2-4-8/types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example @@ -900,27 +897,27 @@ Swatch attribute metadata. { "apply_to": ["SIMPLE"], "code": "4", - "default_value": "abc123", + "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_comparable": true, + "is_filterable": true, + "is_filterable_in_search": false, + "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": true, - "is_visible_on_front": 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": true, "is_wysiwyg_enabled": true, "label": "xyz789", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", - "update_product_preview_image": true, - "use_product_image_for_swatch": false, + "update_product_preview_image": false, + "use_product_image_for_swatch": true, "used_in_product_listing": true } ``` @@ -933,7 +930,7 @@ Swatch attribute metadata. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | Name of the catalog rule | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Name of the catalog rule | #### Example @@ -951,13 +948,13 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -983,39 +980,39 @@ Contains the full set of attributes that can be returned in a category search. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | +| `automatic_sorting` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/2-4-8/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](/reference/graphql/2-4-8/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -1035,30 +1032,30 @@ Contains the full set of attributes that can be returned in a category search. "cms_block": CmsBlock, "created_at": "xyz789", "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", + "default_sort_by": "abc123", "description": "xyz789", - "display_mode": "xyz789", + "display_mode": "abc123", "filter_price_range": 123.45, "id": 123, "image": "abc123", - "include_in_menu": 987, + "include_in_menu": 123, "is_anchor": 123, - "landing_page": 987, - "level": 987, + "landing_page": 123, + "level": 123, "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "xyz789", + "meta_keywords": "abc123", + "meta_title": "abc123", "name": "abc123", - "path": "abc123", + "path": "xyz789", "path_in_store": "xyz789", - "position": 987, - "product_count": 123, + "position": 123, + "product_count": 987, "products": CategoryProducts, - "staged": true, - "uid": 4, - "updated_at": "abc123", - "url_key": "abc123", - "url_path": "xyz789", + "staged": false, + "uid": "4", + "updated_at": "xyz789", + "url_key": "xyz789", + "url_path": "abc123", "url_suffix": "abc123" } ``` @@ -1073,9 +1070,9 @@ Contains details about the products assigned to a category. | Field Name | Description | |------------|-------------| -| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `items` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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 @@ -1098,8 +1095,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | Field Name | Description | |------------|-------------| | `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -1121,43 +1118,43 @@ Contains the hierarchy of categories. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled. | +| `automatic_sorting` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/2-4-8/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | | +| `children_count` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example @@ -1166,40 +1163,40 @@ Contains the hierarchy of categories. "automatic_sorting": "abc123", "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, - "created_at": "xyz789", - "custom_layout_update_file": "xyz789", + "created_at": "abc123", + "custom_layout_update_file": "abc123", "default_sort_by": "xyz789", "description": "xyz789", "display_mode": "abc123", - "filter_price_range": 123.45, - "id": 123, + "filter_price_range": 987.65, + "id": 987, "image": "xyz789", - "include_in_menu": 123, + "include_in_menu": 987, "is_anchor": 123, - "landing_page": 987, + "landing_page": 123, "level": 123, - "meta_description": "xyz789", - "meta_keywords": "xyz789", + "meta_description": "abc123", + "meta_keywords": "abc123", "meta_title": "xyz789", - "name": "xyz789", + "name": "abc123", "path": "xyz789", "path_in_store": "abc123", - "position": 987, + "position": 123, "product_count": 123, "products": CategoryProducts, - "redirect_code": 987, - "relative_url": "abc123", + "redirect_code": 123, + "relative_url": "xyz789", "staged": false, "type": "CMS_PAGE", - "uid": "4", - "updated_at": "xyz789", + "uid": 4, + "updated_at": "abc123", "url_key": "xyz789", "url_path": "xyz789", - "url_suffix": "xyz789" + "url_suffix": "abc123" } ``` @@ -1213,23 +1210,23 @@ Defines details about an individual checkout agreement. | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | -| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | +| `agreement_id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | | `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name given to the condition. | #### Example ```json { - "agreement_id": 987, + "agreement_id": 123, "checkbox_text": "xyz789", "content": "xyz789", "content_height": "abc123", - "is_html": true, + "is_html": false, "mode": "AUTO", "name": "xyz789" } @@ -1265,16 +1262,16 @@ An error encountered while adding an item to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `path` - [`[String]!`](types-q-s.md#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 | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#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": "xyz789", - "path": ["abc123"] + "message": "abc123", + "path": ["xyz789"] } ``` @@ -1308,13 +1305,13 @@ Contains details about errors encountered when a customer clear cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message | | `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -1346,7 +1343,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Cart` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `Cart` object. | #### Example @@ -1387,7 +1384,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -1403,9 +1400,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-8/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-8/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-8/types-f-i.md#internalerror) | #### Example @@ -1424,7 +1421,7 @@ Contains details about a failed close operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1443,7 +1440,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/2-4-8/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1462,12 +1459,12 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -1480,10 +1477,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `closed_quotes` - [`[NegotiableQuote]`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/2-4-8/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/2-4-8/types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1508,9 +1505,9 @@ Contains details about a specific CMS block. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | -| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | +| `content` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The title assigned to the CMS block. | #### Example @@ -1550,35 +1547,35 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | +| `content` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { "content": "xyz789", - "content_heading": "abc123", + "content_heading": "xyz789", "identifier": "abc123", "meta_description": "abc123", "meta_keywords": "abc123", "meta_title": "abc123", - "page_layout": "abc123", - "redirect_code": 123, - "relative_url": "xyz789", - "title": "xyz789", + "page_layout": "xyz789", + "redirect_code": 987, + "relative_url": "abc123", + "title": "abc123", "type": "CMS_PAGE", - "url_key": "xyz789" + "url_key": "abc123" } ``` @@ -1590,7 +1587,7 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -1627,7 +1624,7 @@ Specifies which field to sort on, and whether to return the results in ascending | Input Field | Description | |-------------|-------------| | `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | +| `order` - [`SortEnum!`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1649,13 +1646,13 @@ Contains the output schema for a 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`](types-q-s.md#string) | The email address of the company contact. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | -| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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. | @@ -1663,7 +1660,7 @@ Contains the output schema for a company. | `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`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1673,13 +1670,13 @@ Contains the output schema for a company. "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "abc123", + "email": "xyz789", "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", "name": "abc123", "payment_methods": ["xyz789"], - "reseller_id": "xyz789", + "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1687,7 +1684,7 @@ Contains the output schema for a company. "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } ``` @@ -1702,17 +1699,17 @@ Contains details about the access control list settings of a resource. | Field Name | Description | |------------|-------------| | `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | -| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the ACL resource. | #### Example ```json { "children": [CompanyAclResource], - "id": 4, - "sort_order": 123, + "id": "4", + "sort_order": 987, "text": "xyz789" } ``` @@ -1727,25 +1724,25 @@ Defines the input schema for creating a company administrator. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | -| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | -| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | -| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company administrator. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company administrator's last name. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The phone number of the company administrator. | #### Example ```json { "custom_attributes": [AttributeValueInput], - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "gender": 123, - "job_title": "xyz789", + "job_title": "abc123", "lastname": "xyz789", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1759,17 +1756,17 @@ The minimal required information to identify and display the company. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the company. | #### Example ```json { "id": "4", - "legal_name": "xyz789", - "name": "abc123" + "legal_name": "abc123", + "name": "xyz789" } ``` @@ -1784,12 +1781,12 @@ Defines the input schema for creating a new company. | Input Field | Description | |-------------|-------------| | `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String!`](types-q-s.md#string) | The name of the company to create. | +| `company_email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the company to create. | | `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1797,9 +1794,9 @@ Defines the input schema for creating a new company. { "company_admin": CompanyAdminInput, "company_email": "xyz789", - "company_name": "xyz789", + "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "xyz789", + "legal_name": "abc123", "reseller_id": "xyz789", "vat_tax_id": "xyz789" } @@ -1815,9 +1812,9 @@ Contains company credit balances and limits. | Field Name | Description | |------------|-------------| -| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](types-k-p.md#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. | +| `available_credit` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#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!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#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 @@ -1840,8 +1837,8 @@ Contains details about prior company credit operations. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1849,7 +1846,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1863,17 +1860,17 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The name of the person submitting the company credit operation. | +| `updated_by` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "custom_reference_number": "abc123", + "custom_reference_number": "xyz789", "operation_type": "ALLOCATION", - "updated_by": "abc123" + "updated_by": "xyz789" } ``` @@ -1887,10 +1884,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the company credit operation. | +| `amount` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of the company credit operation. | | `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](types-q-s.md#string) | The date the operation occurred. | +| `custom_reference_number` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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. | @@ -1901,7 +1898,7 @@ Contains details about a single company credit operation. "amount": Money, "balance": CompanyCredit, "custom_reference_number": "abc123", - "date": "xyz789", + "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser } @@ -1938,13 +1935,13 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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"} +{"name": "xyz789", "type": "CUSTOMER"} ``` @@ -1974,16 +1971,16 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The invitation code. | -| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "code": "abc123", - "role_id": "4", + "code": "xyz789", + "role_id": 4, "user": CompanyInvitationUserInput } ``` @@ -1998,7 +1995,7 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example @@ -2016,17 +2013,17 @@ Company user attributes in the invitation. | Input Field | Description | |-------------|-------------| -| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | -| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `company_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The job title of a company user. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The phone number of the company user. | #### Example ```json { - "company_id": 4, + "company_id": "4", "customer_id": 4, "job_title": "xyz789", "status": "ACTIVE", @@ -2044,12 +2041,12 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The company's postal code. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company's postal code. | | `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | +| `street` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company's phone number. | #### Example @@ -2057,10 +2054,10 @@ Contains details about the address where the company is registered to conduct bu { "city": "abc123", "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegion, "street": ["xyz789"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2074,12 +2071,12 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2087,10 +2084,10 @@ Defines the input schema for defining a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput, "street": ["abc123"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -2104,23 +2101,23 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The city where the company is registered to conduct business. | | `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "country_id": "AF", "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -2134,17 +2131,17 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the role. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name assigned to the role. | | `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | +| `users_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { "id": 4, - "name": "abc123", + "name": "xyz789", "permissions": [CompanyAclResource], "users_count": 987 } @@ -2160,8 +2157,8 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | -| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | A list of resources the role can access. | #### Example @@ -2182,17 +2179,17 @@ Defines the input schema for updating a company role. | Input Field | Description | |-------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | -| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { "id": "4", - "name": "xyz789", - "permissions": ["xyz789"] + "name": "abc123", + "permissions": ["abc123"] } ``` @@ -2207,8 +2204,8 @@ Contains an array of roles. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2216,7 +2213,7 @@ Contains an array of roles. { "items": [CompanyRole], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2230,15 +2227,15 @@ Contains details about a company sales representative. | Field Name | Description | |------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | -| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | -| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "abc123", "lastname": "xyz789" } @@ -2290,17 +2287,13 @@ Defines an individual node in the company structure. | Field Name | Description | |------------|-------------| | `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example ```json -{ - "entity": CompanyTeam, - "id": "4", - "parent_id": 4 -} +{"entity": CompanyTeam, "id": 4, "parent_id": 4} ``` @@ -2313,13 +2306,13 @@ Defines the input schema for updating the company structure. | Input Field | Description | |-------------|-------------| -| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | +| `parent_tree_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": "4", "tree_id": 4} +{"parent_tree_id": 4, "tree_id": "4"} ``` @@ -2332,19 +2325,19 @@ Describes a company team. | Field Name | Description | |------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | -| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | ID of the company structure | #### Example ```json { - "description": "xyz789", + "description": "abc123", "id": "4", "name": "xyz789", - "structure_id": "4" + "structure_id": 4 } ``` @@ -2358,17 +2351,17 @@ Defines the input schema for creating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "description": "abc123", - "name": "abc123", - "target_id": 4 + "description": "xyz789", + "name": "xyz789", + "target_id": "4" } ``` @@ -2382,17 +2375,17 @@ Defines the input schema for updating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the team. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "id": 4, - "name": "xyz789" + "name": "abc123" } ``` @@ -2406,12 +2399,12 @@ Defines the input schema for updating a company. | Input Field | Description | |-------------|-------------| -| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String`](types-q-s.md#string) | The name of the company to update. | +| `company_email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the company to update. | | `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -2420,9 +2413,9 @@ Defines the input schema for updating a company. "company_email": "abc123", "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "xyz789", - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } ``` @@ -2436,24 +2429,24 @@ Defines the input schema for creating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The company user's email address | -| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | -| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | -| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | +| `target_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", - "firstname": "abc123", + "email": "abc123", + "firstname": "xyz789", "job_title": "abc123", - "lastname": "abc123", - "role_id": "4", + "lastname": "xyz789", + "role_id": 4, "status": "ACTIVE", "target_id": "4", "telephone": "abc123" @@ -2489,27 +2482,27 @@ Defines the input schema for updating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The company user's email address. | -| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "id": "4", - "job_title": "xyz789", - "lastname": "xyz789", - "role_id": 4, + "job_title": "abc123", + "lastname": "abc123", + "role_id": "4", "status": "ACTIVE", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -2524,8 +2517,8 @@ Contains details about company users. | Field Name | Description | |------------|-------------| | `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of objects returned. | #### Example @@ -2533,7 +2526,7 @@ Contains details about company users. { "items": [Customer], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2565,8 +2558,8 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The label of the attribute code. | #### Example @@ -2587,9 +2580,9 @@ Defines an object used to iterate through items for product comparisons. | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | +| `attributes` - [`[ProductAttribute]!`](/reference/graphql/2-4-8/types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2597,7 +2590,7 @@ Defines an object used to iterate through items for product comparisons. { "attributes": [ProductAttribute], "product": ProductInterface, - "uid": "4" + "uid": 4 } ``` @@ -2612,9 +2605,9 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| | `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](types-f-i.md#int) | The number of items in the compare list. | +| `item_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of items in the compare list. | | `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example @@ -2623,7 +2616,7 @@ Contains iterable information such as the array of items, the count, and attribu "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } ``` @@ -2635,12 +2628,12 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| -| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | +| `html` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Text that can contain HTML tags. | #### Example ```json -{"html": "abc123"} +{"html": "xyz789"} ``` @@ -2653,10 +2646,10 @@ Contains details about a configurable product attribute option. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | -| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example @@ -2665,7 +2658,7 @@ Contains details about a configurable product attribute option. "code": "abc123", "label": "abc123", "uid": "4", - "value_index": 123 + "value_index": 987 } ``` @@ -2679,25 +2672,25 @@ An implementation for configurable product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#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`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2711,17 +2704,17 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": false, - "max_qty": 123.45, - "min_qty": 123.45, + "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": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -2735,14 +2728,14 @@ Describes configurable options that have been selected and can be selected as a | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "option_value_uids": ["4"] } ``` @@ -2756,35 +2749,35 @@ Describes configurable options that have been selected and can be selected as a | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/2-4-8/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the order item. | #### Example ```json { "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -2794,18 +2787,18 @@ Describes configurable options that have been selected and can be selected as a "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "xyz789", - "product_url_key": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 987.65, "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, "quantity_return_requested": 123.45, - "quantity_returned": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -2819,126 +2812,126 @@ Defines basic features of a configurable product and its simple product variants | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `activity` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `category_gear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-8/types-k-p.md#productcustomattributes) | Product custom attributes. | | `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `eco_collection` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `options_container` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-8/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-8/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-8/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | The list of products reviews. | | `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sale` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `size` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-8/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-8/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/2-4-8/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "xyz789", - "attribute_set_id": 987, - "canonical_url": "xyz789", + "activity": "abc123", + "attribute_set_id": 123, + "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "xyz789", - "climate": "xyz789", - "collar": "abc123", + "climate": "abc123", + "collar": "xyz789", "color": 987, "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, "country_of_manufacture": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "eco_collection": 123, "erin_recommends": 123, - "features_bags": "xyz789", - "format": 987, - "gender": "xyz789", + "features_bags": "abc123", + "format": 123, + "gender": "abc123", "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 123, + "manufacturer": 987, "material": "xyz789", "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], @@ -2946,34 +2939,34 @@ Defines basic features of a configurable product and its simple product variants "meta_description": "xyz789", "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", "new": 987, - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", - "pattern": "abc123", + "pattern": "xyz789", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 123, + "purpose": 987, "quantity": 123.45, "rating_summary": 987.65, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, + "relative_url": "xyz789", + "review_count": 123, "reviews": ProductReviews, "rules": [CatalogRule], "sale": 987, "short_description": ComplexTextValue, - "size": 987, + "size": 123, "sku": "abc123", - "sleeve": "abc123", + "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "abc123", "special_price": 987.65, @@ -2981,25 +2974,25 @@ Defines basic features of a configurable product and its simple product variants "staged": false, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "abc123", "style_general": "xyz789", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": "4", - "updated_at": "abc123", + "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "variants": [ConfigurableVariant], "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -3013,8 +3006,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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`](types-q-s.md#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](types-q-s.md#string) | | +| `parent_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example @@ -3022,7 +3015,7 @@ Defines basic features of a configurable product and its simple product variants { "customizable_options": [CustomizableOptionInput], "data": CartItemInput, - "parent_sku": "xyz789", + "parent_sku": "abc123", "variant_sku": "xyz789" } ``` @@ -3037,9 +3030,9 @@ Contains details about configurable product options. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the configurable option. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the configurable option. | | `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example @@ -3047,8 +3040,8 @@ Contains details about configurable product options. ```json { "attribute_code": "abc123", - "label": "xyz789", - "uid": "4", + "label": "abc123", + "uid": 4, "values": [ConfigurableProductOptionValue] } ``` @@ -3063,21 +3056,21 @@ Defines a value for a configurable product option. | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](/reference/graphql/2-4-8/types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the value. | #### Example ```json { - "is_available": false, - "is_use_default": true, + "is_available": true, + "is_use_default": false, "label": "abc123", "swatch": SwatchDataInterface, - "uid": 4 + "uid": "4" } ``` @@ -3091,31 +3084,31 @@ Defines configurable attributes for the specified product. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is the default. | +| `attribute_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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": "abc123", + "attribute_code": "xyz789", "attribute_id": "xyz789", "attribute_id_v2": 123, - "attribute_uid": "4", - "id": 987, - "label": "abc123", - "position": 987, - "product_id": 987, - "uid": 4, + "attribute_uid": 4, + "id": 123, + "label": "xyz789", + "position": 123, + "product_id": 123, + "uid": "4", "use_default": true, "values": [ConfigurableProductOptionsValues] } @@ -3132,9 +3125,9 @@ Contains metadata corresponding to the selected configurable options. | Field Name | Description | |------------|-------------| | `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#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`](types-q-s.md#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. | +| `variant` - [`SimpleProduct`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -3159,23 +3152,23 @@ Contains the index number assigned to a configurable product option. | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | -| `label` - [`String`](types-q-s.md#string) | The label of the product. | -| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | +| `default_label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](/reference/graphql/2-4-8/types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "default_label": "abc123", - "label": "xyz789", + "default_label": "xyz789", + "label": "abc123", "store_label": "abc123", "swatch_data": SwatchDataInterface, - "uid": "4", + "uid": 4, "use_default_value": false, "value_index": 123 } @@ -3191,11 +3184,11 @@ Contains details about configurable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](/reference/graphql/2-4-8/types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -3205,7 +3198,7 @@ Contains details about configurable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -3220,7 +3213,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](/reference/graphql/2-4-8/types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -3241,27 +3234,27 @@ A configurable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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]`](/reference/graphql/2-4-8/types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", - "child_sku": "abc123", + "added_at": "xyz789", + "child_sku": "xyz789", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": 4, + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -3275,15 +3268,15 @@ A configurable product wish list item. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an `Order` type. | #### Example ```json { - "confirmation_key": "xyz789", - "order_id": 4 + "confirmation_key": "abc123", + "order_id": "4" } ``` @@ -3297,15 +3290,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | -| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address to be confirmed. | #### Example ```json { - "confirmation_key": "xyz789", - "email": "xyz789" + "confirmation_key": "abc123", + "email": "abc123" } ``` @@ -3317,15 +3310,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an `Order` type. | #### Example ```json { "confirmation_key": "xyz789", - "order_id": "4" + "order_id": 4 } ``` @@ -3356,18 +3349,18 @@ List of account confirmation statuses. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | -| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | -| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | +| `comment` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The shopper's telephone number. | #### Example ```json { - "comment": "abc123", - "email": "xyz789", - "name": "abc123", + "comment": "xyz789", + "email": "abc123", + "name": "xyz789", "telephone": "xyz789" } ``` @@ -3382,7 +3375,7 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example @@ -3400,7 +3393,7 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example @@ -3418,7 +3411,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3436,9 +3429,9 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3458,12 +3451,12 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | -| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | -| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | +| `available_regions` - [`[Region]`](/reference/graphql/2-4-8/types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example @@ -3471,9 +3464,9 @@ Contains the source and target wish lists after copying products. { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "xyz789", - "id": "xyz789", - "three_letter_abbreviation": "abc123", + "full_name_locale": "abc123", + "id": "abc123", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "abc123" } ``` @@ -3822,7 +3815,7 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example @@ -3840,14 +3833,14 @@ Defines a new gift registry. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | -| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-8/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](/reference/graphql/2-4-8/types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](/reference/graphql/2-4-8/types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/2-4-8/types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](/reference/graphql/2-4-8/types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3856,9 +3849,9 @@ Defines a new gift registry. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "xyz789", + "event_name": "abc123", "gift_registry_type_uid": 4, - "message": "xyz789", + "message": "abc123", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -3876,7 +3869,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3892,7 +3885,7 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | Optional client-generated ID | #### Example @@ -3926,21 +3919,21 @@ Contains the secure information used to authorize transaction. Applies to Payflo | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | +| `response_message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { - "response_message": "abc123", + "response_message": "xyz789", "result": 987, - "result_code": 987, + "result_code": 123, "secure_token": "xyz789", - "secure_token_id": "xyz789" + "secure_token_id": "abc123" } ``` @@ -3954,11 +3947,11 @@ Contains payment order details that are used while processing the payment order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | +| `cartId` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](/reference/graphql/2-4-8/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example @@ -3968,7 +3961,7 @@ Contains payment order details that are used while processing the payment order "location": "PRODUCT_DETAIL", "methodCode": "abc123", "paymentSource": "abc123", - "vaultIntent": false + "vaultIntent": true } ``` @@ -3982,20 +3975,20 @@ Contains payment order details that are used while processing the payment order | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | -| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `amount` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the payment order | #### Example ```json { - "amount": 123.45, - "currency_code": "abc123", - "id": "xyz789", - "mp_order_id": "abc123", + "amount": 987.65, + "currency_code": "xyz789", + "id": "abc123", + "mp_order_id": "xyz789", "status": "abc123" } ``` @@ -4010,21 +4003,21 @@ Defines a new product review. | Input Field | Description | |-------------|-------------| -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `nickname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](/reference/graphql/2-4-8/types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The review text. | #### Example ```json { - "nickname": "xyz789", + "nickname": "abc123", "ratings": [ProductReviewRatingInput], "sku": "abc123", - "summary": "xyz789", - "text": "xyz789" + "summary": "abc123", + "text": "abc123" } ``` @@ -4038,7 +4031,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | +| `review` - [`ProductReview!`](/reference/graphql/2-4-8/types-k-p.md#productreview) | Product review details. | #### Example @@ -4057,12 +4050,12 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example ```json -{"currency": "AFN", "value": 123.45} +{"currency": "AFN", "value": 987.65} ``` @@ -4076,9 +4069,9 @@ Defines a set of conditions that apply to a rule. | 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!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -4087,7 +4080,7 @@ Defines a set of conditions that apply to a rule. "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, "attribute": "GRAND_TOTAL", "operator": "MORE_THAN", - "quantity": 123 + "quantity": 987 } ``` @@ -4101,15 +4094,15 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { - "description": "xyz789", - "name": "xyz789" + "description": "abc123", + "name": "abc123" } ``` @@ -4123,7 +4116,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -4141,14 +4134,14 @@ Describe the variables needed to create a vault payment token | Input Field | Description | |-------------|-------------| -| `card_description` - [`String`](types-q-s.md#string) | Description of the vaulted card | -| `setup_token_id` - [`String!`](types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | +| `card_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example ```json { - "card_description": "abc123", + "card_description": "xyz789", "setup_token_id": "xyz789" } ``` @@ -4163,8 +4156,8 @@ The vault token id and information about the payment source | Field Name | Description | |------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](types-k-p.md#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](types-q-s.md#string) | The vault payment token information | +| `payment_source` - [`PaymentSourceOutput!`](/reference/graphql/2-4-8/types-k-p.md#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The vault payment token information | #### Example @@ -4185,8 +4178,8 @@ Describe the variables needed to create a vault card setup token | Input Field | Description | |-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](types-t-z.md#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | The 3DS mode | +| `setup_token` - [`VaultSetupTokenInput!`](/reference/graphql/2-4-8/types-t-z.md#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/2-4-8/types-t-z.md#threedsmode) | The 3DS mode | #### Example @@ -4207,12 +4200,12 @@ The setup token id information | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](types-q-s.md#string) | The setup token id | +| `setup_token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The setup token id | #### Example ```json -{"setup_token": "xyz789"} +{"setup_token": "abc123"} ``` @@ -4225,13 +4218,13 @@ Defines the name and visibility of a new wish list. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](/reference/graphql/2-4-8/types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json -{"name": "abc123", "visibility": "PUBLIC"} +{"name": "xyz789", "visibility": "PUBLIC"} ``` @@ -4244,7 +4237,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -4262,16 +4255,16 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | Input Field | Description | |-------------|-------------| -| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | +| `cc_exp_month` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The credit card type. | #### Example ```json { - "cc_exp_month": 987, + "cc_exp_month": 123, "cc_exp_year": 123, "cc_last_4": 123, "cc_type": "xyz789" @@ -4288,10 +4281,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-8/types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CreditMemo` object. | | `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | +| `number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -4299,9 +4292,9 @@ Contains credit memo details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [CreditMemoItemInterface], - "number": "xyz789", + "number": "abc123", "total": CreditMemoTotal } ``` @@ -4315,24 +4308,24 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | #### Example ```json { "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -4347,20 +4340,20 @@ Credit memo item details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| -| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | +| [`BundleCreditMemoItem`](/reference/graphql/2-4-8/types-a-b.md#bundlecreditmemoitem) | | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | +| [`GiftCardCreditMemoItem`](/reference/graphql/2-4-8/types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -4368,9 +4361,9 @@ Credit memo item details. ```json { "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 987.65 @@ -4387,15 +4380,15 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `adjustment` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The final base grand total amount in the base currency. | | `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | +| `grand_total` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-8/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-8/types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4421,13 +4414,13 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](types-q-s.md#string) | The currency symbol that is displayed by default, such as $. | +| `available_currency_codes` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -4437,9 +4430,9 @@ Contains credit memo price details. "available_currency_codes": ["abc123"], "base_currency_code": "abc123", "base_currency_symbol": "abc123", - "default_display_currecy_code": "xyz789", + "default_display_currecy_code": "abc123", "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } @@ -4642,7 +4635,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](/reference/graphql/2-4-8/types-a-b.md#attribute) | An array of attributes. | #### Example @@ -4660,37 +4653,37 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-8/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-8/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](types-a-b.md#attributemetadata) | +| [`AttributeMetadata`](/reference/graphql/2-4-8/types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](/reference/graphql/2-4-8/types-q-s.md#returnitemattributemetadata) | #### Example ```json { "code": "4", - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "abc123", "frontend_input": "BOOLEAN", "is_required": false, "is_unique": false, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -4703,22 +4696,22 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `is_default` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](/reference/graphql/2-4-8/types-a-b.md#attributeoptionmetadata) | #### Example ```json { "is_default": true, - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -4735,53 +4728,53 @@ Defines the customer name, addresses, and other details. |------------|-------------| | `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!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](types-t-z.md#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `allow_remote_shopping_assistance` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](/reference/graphql/2-4-8/types-t-z.md#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`](types-q-s.md#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | Details about a specific gift registry. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | Details about a specific gift registry. | | `group` - [`CustomerGroup`](#customergroup) | Name of the customer group assigned to the customer | -| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `group_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's middle name. | | `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](types-q-s.md#rewardpoints) | Customer reward points details. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](/reference/graphql/2-4-8/types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](/reference/graphql/2-4-8/types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](/reference/graphql/2-4-8/types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](/reference/graphql/2-4-8/types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](/reference/graphql/2-4-8/types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-f-i.md#id) | ID of the company structure | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `structure_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#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. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/2-4-8/types-t-z.md#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 @@ -4795,30 +4788,30 @@ Defines the customer name, addresses, and other details. "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "abc123", - "default_shipping": "xyz789", + "default_shipping": "abc123", "dob": "xyz789", "email": "abc123", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroup, "group_id": 987, "id": 987, "is_subscribed": false, - "job_title": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", + "job_title": "xyz789", + "lastname": "abc123", + "middlename": "abc123", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -4832,7 +4825,7 @@ Defines the customer name, addresses, and other details. "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -4849,53 +4842,53 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's company. | | `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](types-q-s.md#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `country_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | | `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `customer_id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the customer's default shipping address. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `fax` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-f-i.md#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 123, + "customer_id": 987, "default_billing": true, - "default_shipping": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", "firstname": "xyz789", - "id": 987, + "id": 123, "lastname": "abc123", "middlename": "xyz789", "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", @@ -4913,8 +4906,8 @@ Specifies the attribute code and value of a customer address attribute. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | +| `attribute_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example @@ -4935,8 +4928,8 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | -| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The value assigned to the attribute. | #### Example @@ -4957,42 +4950,42 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributesV2` - [`[AttributeValueInput]`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `street` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country_code": "AF", "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], "custom_attributesV2": [AttributeValueInput], "default_billing": true, - "default_shipping": false, - "fax": "xyz789", - "firstname": "abc123", + "default_shipping": true, + "fax": "abc123", + "firstname": "xyz789", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegionInput, @@ -5013,9 +5006,9 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -5037,17 +5030,17 @@ Defines the customer's state or province. | Input Field | Description | |-------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "region": "abc123", - "region_code": "abc123", - "region_id": 123 + "region_code": "xyz789", + "region_id": 987 } ``` @@ -5060,8 +5053,8 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer addresses. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of customer addresses. | #### Example @@ -5083,19 +5076,19 @@ Customer attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-8/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-8/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/2-4-8/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of lines of the attribute value. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/2-4-8/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example @@ -5107,12 +5100,12 @@ Customer attribute metadata. "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": false, + "is_required": true, "is_unique": true, - "label": "abc123", - "multiline_count": 987, + "label": "xyz789", + "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -5127,20 +5120,20 @@ An input object for creating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | | -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -5151,12 +5144,12 @@ An input object for creating a customer. "date_of_birth": "xyz789", "dob": "xyz789", "email": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "gender": 987, "is_subscribed": false, "lastname": "xyz789", - "middlename": "abc123", - "password": "abc123", + "middlename": "xyz789", + "password": "xyz789", "prefix": "xyz789", "suffix": "abc123", "taxvat": "abc123" @@ -5173,19 +5166,19 @@ Contains details about a single downloadable product. | Field Name | Description | |------------|-------------| -| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | -| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | +| `date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "date": "abc123", + "date": "xyz789", "download_url": "abc123", - "order_increment_id": "xyz789", + "order_increment_id": "abc123", "remaining_downloads": "abc123", "status": "abc123" } @@ -5219,12 +5212,12 @@ Data of customer group. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | The name of customer group. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of customer group. | #### Example ```json -{"name": "abc123"} +{"name": "xyz789"} ``` @@ -5237,18 +5230,18 @@ An input object that assigns or updates customer attributes. | Input Field | Description | |-------------|-------------| -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `date_of_birth` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -5257,12 +5250,12 @@ An input object that assigns or updates customer attributes. "date_of_birth": "abc123", "dob": "xyz789", "email": "xyz789", - "firstname": "abc123", - "gender": 123, - "is_subscribed": false, + "firstname": "xyz789", + "gender": 987, + "is_subscribed": true, "lastname": "xyz789", - "middlename": "xyz789", - "password": "xyz789", + "middlename": "abc123", + "password": "abc123", "prefix": "xyz789", "suffix": "xyz789", "taxvat": "abc123" @@ -5279,39 +5272,39 @@ Contains details about each of the customer's orders. | Field Name | Description | |------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | -| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | -| `available_actions` - [`[OrderActionType]!`](types-k-p.md#orderactiontype) | List of available order actions. | -| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `applied_coupons` - [`[AppliedCoupon]!`](/reference/graphql/2-4-8/types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](/reference/graphql/2-4-8/types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](/reference/graphql/2-4-8/types-k-p.md#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](/reference/graphql/2-4-8/types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-8/types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | | `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `customer_info` - [`OrderCustomerInfo!`](types-k-p.md#ordercustomerinfo) | Returns customer information from order. | -| `email` - [`String`](types-q-s.md#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | `TRUE` if the order is virtual | -| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](types-q-s.md#string) | The order number. | -| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | -| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | -| `order_status_change_date` - [`String!`](types-q-s.md#string) | The date the order status was last updated. | -| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | -| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | -| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | +| `customer_info` - [`OrderCustomerInfo!`](/reference/graphql/2-4-8/types-k-p.md#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](/reference/graphql/2-4-8/types-f-i.md#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `order_status_change_date` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](/reference/graphql/2-4-8/types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](/reference/graphql/2-4-8/types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](/reference/graphql/2-4-8/types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](/reference/graphql/2-4-8/types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](/reference/graphql/2-4-8/types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -5326,27 +5319,27 @@ Contains details about each of the customer's orders. "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": "xyz789", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "abc123", - "order_date": "abc123", + "order_date": "xyz789", "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": "xyz789", + "shipping_method": "abc123", "status": "abc123", "token": "abc123", "total": OrderTotal @@ -5363,7 +5356,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -5401,10 +5394,10 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| -| `date_of_first_order` - [`String`](types-q-s.md#string) | Date of the first order placed in the store | +| `date_of_first_order` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Date of the first order placed in the store | | `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of customer orders. | #### Example @@ -5413,7 +5406,7 @@ The collection of orders that match the conditions defined in the filter. "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5427,10 +5420,10 @@ Identifies the filter to use for filtering orders. | Input Field | Description | |-------------|-------------| -| `grand_total` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | -| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | -| `order_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | -| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filters by order status. | +| `grand_total` - [`FilterRangeTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filters by order status. | #### Example @@ -5471,7 +5464,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](/reference/graphql/2-4-8/types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5490,16 +5483,16 @@ Customer segment. | Field Name | Description | |------------|-------------| | `apply_to` - [`CustomerSegmentApplyTo!`](#customersegmentapplyto) | Customer segment is applicable to visitor, registered customer or both. | -| `description` - [`String`](types-q-s.md#string) | Customer segment description. | -| `name` - [`String!`](types-q-s.md#string) | Customer segment name. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Customer segment description. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Customer segment name. | #### Example ```json { "apply_to": "BOTH", - "description": "xyz789", - "name": "xyz789" + "description": "abc123", + "name": "abc123" } ``` @@ -5534,8 +5527,8 @@ Contains store credit information with balance and history. | 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`](types-k-p.md#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | +| `current_balance` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5543,7 +5536,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": false + "enabled": true } ``` @@ -5558,8 +5551,8 @@ Lists changes to the amount of store credit available to the customer. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of items returned. | #### Example @@ -5567,7 +5560,7 @@ Lists changes to the amount of store credit available to the customer. { "items": [CustomerStoreCreditHistoryItem], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5581,10 +5574,10 @@ Contains store credit history information. | Field Name | Description | |------------|-------------| -| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | +| `action` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time when the store credit change was made. | #### Example @@ -5593,7 +5586,7 @@ Contains store credit history information. "action": "xyz789", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "abc123" + "date_time_changed": "xyz789" } ``` @@ -5607,7 +5600,7 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | +| `token` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer authorization token. | #### Example @@ -5625,35 +5618,35 @@ An input object for updating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "dob": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "gender": 123, - "is_subscribed": false, + "is_subscribed": true, "lastname": "xyz789", "middlename": "xyz789", "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "xyz789" + "suffix": "abc123", + "taxvat": "abc123" } ``` @@ -5667,23 +5660,23 @@ Contains information about a text area that is defined as part of a customizable | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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", + "option_id": 987, + "product_sku": "abc123", "required": true, - "sort_order": 987, - "title": "xyz789", + "sort_order": 123, + "title": "abc123", "uid": 4, "value": CustomizableAreaValue } @@ -5699,11 +5692,11 @@ Defines the price and sku of a product whose page contains a customized text are | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | +| `max_characters` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example @@ -5727,22 +5720,22 @@ Contains information about a set of checkbox values that are defined as part of | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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": 123, - "title": "xyz789", - "uid": "4", + "option_id": 123, + "required": false, + "sort_order": 987, + "title": "abc123", + "uid": 4, "value": [CustomizableCheckboxValue] } ``` @@ -5757,23 +5750,23 @@ Defines the price and sku of a product whose page contains a customized set of c | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "option_type_id": 123, - "price": 987.65, + "option_type_id": 987, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", - "sort_order": 123, + "sort_order": 987, "title": "xyz789", "uid": 4 } @@ -5789,24 +5782,24 @@ Contains information about a date picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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": 123, - "product_sku": "abc123", + "option_id": 987, + "product_sku": "xyz789", "required": true, "sort_order": 987, - "title": "xyz789", - "uid": "4", + "title": "abc123", + "uid": 4, "value": CustomizableDateValue } ``` @@ -5841,11 +5834,11 @@ Defines the price and sku of a product whose page contains a customized date pic | Field Name | Description | |------------|-------------| -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | | `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example @@ -5853,7 +5846,7 @@ Defines the price and sku of a product whose page contains a customized date pic { "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "type": "DATE", "uid": 4 } @@ -5869,20 +5862,20 @@ Contains information about a drop down menu that is defined as part of a customi | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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, + "option_id": 123, + "required": false, + "sort_order": 987, "title": "abc123", "uid": "4", "value": [CustomizableDropDownValue] @@ -5899,24 +5892,24 @@ Defines the price and sku of a product whose page contains a customized drop dow | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 987.65, "price_type": "FIXED", - "sku": "abc123", - "sort_order": 123, - "title": "abc123", + "sku": "xyz789", + "sort_order": 987, + "title": "xyz789", "uid": "4" } ``` @@ -5931,22 +5924,22 @@ Contains information about a text field that is defined as part of a customizabl | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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": "xyz789", + "option_id": 123, + "product_sku": "abc123", "required": true, - "sort_order": 123, + "sort_order": 987, "title": "abc123", "uid": "4", "value": CustomizableFieldValue @@ -5963,21 +5956,21 @@ Defines the price and sku of a product whose page contains a customized text fie | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | +| `max_characters` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { "max_characters": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" + "sku": "abc123", + "uid": 4 } ``` @@ -5991,12 +5984,12 @@ Contains information about a file picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -6006,7 +5999,7 @@ Contains information about a file picker that is defined as part of a customizab "option_id": 123, "product_sku": "abc123", "required": true, - "sort_order": 123, + "sort_order": 987, "title": "abc123", "uid": "4", "value": CustomizableFileValue @@ -6023,24 +6016,24 @@ Defines the price and sku of a product whose page contains a customized file pic | Field Name | Description | |------------|-------------| -| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | -| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | +| `file_extension` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "file_extension": "xyz789", + "file_extension": "abc123", "image_size_x": 123, - "image_size_y": 987, + "image_size_y": 123, "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "uid": "4" } ``` @@ -6055,11 +6048,11 @@ Contains information about a multiselect that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example @@ -6067,9 +6060,9 @@ Contains information about a multiselect that is defined as part of a customizab ```json { "option_id": 987, - "required": false, - "sort_order": 987, - "title": "xyz789", + "required": true, + "sort_order": 123, + "title": "abc123", "uid": 4, "value": [CustomizableMultipleValue] } @@ -6085,23 +6078,23 @@ Defines the price and sku of a product whose page contains a customized multisel | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { "option_type_id": 123, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "sort_order": 987, + "sort_order": 123, "title": "abc123", "uid": 4 } @@ -6117,9 +6110,9 @@ Defines a customizable option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The customizable option ID of the product. | +| `uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The string value of the option. | #### Example @@ -6141,11 +6134,11 @@ Contains basic information about a customizable option. It can be implemented by | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -6164,11 +6157,11 @@ Contains basic information about a customizable option. It can be implemented by ```json { - "option_id": 123, + "option_id": 987, "required": false, "sort_order": 123, "title": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6188,12 +6181,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`VirtualProduct`](/reference/graphql/2-4-8/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-8/types-q-s.md#simpleproduct) | | [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`BundleProduct`](/reference/graphql/2-4-8/types-a-b.md#bundleproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-8/types-f-i.md#giftcardproduct) | #### Example @@ -6211,11 +6204,11 @@ Contains information about a set of radio buttons that are defined as part of a | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example @@ -6223,10 +6216,10 @@ Contains information about a set of radio buttons that are defined as part of a ```json { "option_id": 987, - "required": false, - "sort_order": 123, + "required": true, + "sort_order": 987, "title": "abc123", - "uid": "4", + "uid": 4, "value": [CustomizableRadioValue] } ``` @@ -6241,13 +6234,13 @@ Defines the price and sku of a product whose page contains a customized set of r | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/2-4-8/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example @@ -6256,10 +6249,10 @@ Defines the price and sku of a product whose page contains a customized set of r "option_type_id": 123, "price": 123.45, "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 987, - "title": "xyz789", - "uid": 4 + "sku": "abc123", + "sort_order": 123, + "title": "abc123", + "uid": "4" } ``` @@ -6273,12 +6266,12 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -6291,12 +6284,12 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -6309,7 +6302,7 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example @@ -6327,7 +6320,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -6343,9 +6336,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-8/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-8/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-8/types-f-i.md#internalerror) | #### Example @@ -6364,7 +6357,7 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -6383,7 +6376,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/2-4-8/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -6402,12 +6395,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -6418,7 +6411,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example @@ -6436,9 +6429,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/2-4-8/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/2-4-8/types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -6463,14 +6456,14 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example ```json { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } ``` @@ -6484,13 +6477,13 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The text of the error message. | +| `message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"message": "xyz789", "type": "UNDEFINED"} +{"message": "abc123", "type": "UNDEFINED"} ``` @@ -6520,7 +6513,7 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example @@ -6556,7 +6549,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6574,8 +6567,8 @@ Indicates whether the request to delete the requisition list was successful. | Field Name | Description | |------------|-------------| -| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | +| `requisition_lists` - [`RequisitionLists`](/reference/graphql/2-4-8/types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example @@ -6593,13 +6586,13 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"status": true, "wishlists": [Wishlist]} +{"status": false, "wishlists": [Wishlist]} ``` @@ -6612,13 +6605,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of the discount. | | `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | -| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | +| `coupon` - [`AppliedCoupon`](/reference/graphql/2-4-8/types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6627,9 +6620,9 @@ Specifies the discount type and value for quote line item. "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": true, - "label": "xyz789", - "type": "xyz789", + "is_discounting_locked": false, + "label": "abc123", + "type": "abc123", "value": 123.45 } ``` @@ -6644,22 +6637,22 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `max_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -6668,19 +6661,19 @@ An implementation for downloadable product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "xyz789", - "is_available": false, + "id": "abc123", + "is_available": true, "links": [DownloadableProductLinks], "max_qty": 987.65, - "min_qty": 987.65, - "not_available_message": "abc123", + "min_qty": 123.45, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": "4" + "uid": 4 } ``` @@ -6696,12 +6689,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | #### Example @@ -6709,7 +6702,7 @@ Defines downloadable product options for `CreditMemoItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -6747,12 +6740,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6760,12 +6753,12 @@ Defines downloadable product options for `InvoiceItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "product_sku": "abc123", + "quantity_invoiced": 987.65 } ``` @@ -6779,9 +6772,9 @@ Defines characteristics of the links for downloadable product. | Field Name | Description | |------------|-------------| -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example @@ -6789,7 +6782,7 @@ Defines characteristics of the links for downloadable product. { "sort_order": 987, "title": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6805,27 +6798,27 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](/reference/graphql/2-4-8/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the order item. | #### Example @@ -6837,21 +6830,21 @@ Defines downloadable product options for `OrderItemInterface`. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "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, + "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_return_requested": 987.65, + "quantity_return_requested": 123.45, "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -6867,109 +6860,109 @@ Defines a product that the shopper downloads. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `activity` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `category_gear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-8/types-k-p.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `eco_collection` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `options_container` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-8/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-8/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-8/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | The list of products reviews. | | `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sale` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#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", +| `size` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-8/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-8/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-8/types-t-z.md#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": 123, + "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "xyz789", "climate": "abc123", "collar": "xyz789", "color": 987, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", + "country_of_manufacture": "abc123", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -6983,33 +6976,33 @@ Defines a product that the shopper downloads. "erin_recommends": 987, "features_bags": "abc123", "format": 987, - "gender": "abc123", - "gift_message_available": false, + "gender": "xyz789", + "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", "links_purchased_separately": 987, - "links_title": "xyz789", + "links_title": "abc123", "manufacturer": 123, - "material": "abc123", + "material": "xyz789", "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "abc123", - "new": 123, + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "name": "xyz789", + "new": 987, "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "pattern": "xyz789", - "performance_fabric": 123, + "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -7017,38 +7010,38 @@ Defines a product that the shopper downloads. "purpose": 123, "quantity": 987.65, "rating_summary": 123.45, - "redirect_code": 987, + "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "abc123", "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, - "size": 123, + "size": 987, "sku": "abc123", - "sleeve": "xyz789", + "sleeve": "abc123", "small_image": ProductImage, "special_from_date": "abc123", "special_price": 987.65, "special_to_date": "abc123", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "abc123", + "strap_bags": "xyz789", + "style_bags": "xyz789", "style_bottom": "xyz789", "style_general": "xyz789", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": 4, + "uid": "4", "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "xyz789", + "url_key": "abc123", + "url_path": "abc123", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website] @@ -7091,32 +7084,32 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](types-a-b.md#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | +| `sample_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { - "id": 987, + "id": 123, "is_shareable": false, "link_type": "FILE", "number_of_downloads": 123, - "price": 987.65, + "price": 123.45, "sample_file": "abc123", "sample_type": "FILE", - "sample_url": "xyz789", + "sample_url": "abc123", "sort_order": 987, - "title": "abc123", + "title": "xyz789", "uid": 4 } ``` @@ -7131,7 +7124,7 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example @@ -7149,23 +7142,23 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | +| `sample_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the sample. | #### Example ```json { "id": 987, - "sample_file": "abc123", + "sample_file": "xyz789", "sample_type": "FILE", "sample_url": "xyz789", - "sort_order": 123, - "title": "abc123" + "sort_order": 987, + "title": "xyz789" } ``` @@ -7179,12 +7172,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of the product added to the requisition list. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -7209,26 +7202,26 @@ A downloadable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `added_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | | `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": 4, "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples] } ``` @@ -7243,13 +7236,16 @@ Identifies a quote to be duplicated | Input Field | Description | |-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | +| `duplicated_quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | ID of the quote to be duplicated. | #### Example ```json -{"duplicated_quote_uid": 4, "quote_uid": 4} +{ + "duplicated_quote_uid": "4", + "quote_uid": 4 +} ``` @@ -7262,7 +7258,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -7281,7 +7277,7 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example @@ -7342,8 +7338,8 @@ Contains an array of dynamic blocks. | Field Name | Description | |------------|-------------| | `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -7365,7 +7361,7 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](types-f-i.md#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -7389,14 +7385,14 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | +| `attribute_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The text or other entered value. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "abc123" } ``` @@ -7411,16 +7407,13 @@ Defines a customer-entered option. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Text the customer entered. | #### Example ```json -{ - "uid": "4", - "value": "abc123" -} +{"uid": 4, "value": "abc123"} ``` @@ -7433,21 +7426,21 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "entity_uid": 4, - "id": 987, - "redirectCode": 987, + "id": 123, + "redirectCode": 123, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -7464,21 +7457,21 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | #### Possible Types | Error Types | |----------------| | [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](types-f-i.md#insufficientstockerror) | +| [`InsufficientStockError`](/reference/graphql/2-4-8/types-f-i.md#insufficientstockerror) | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -7490,15 +7483,15 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/2-4-8/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/2-4-8/types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/2-4-8/types-k-p.md#negotiablequoteinvalidstateerror) | #### Example @@ -7517,7 +7510,7 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -7525,7 +7518,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput } ``` @@ -7539,15 +7532,15 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](/reference/graphql/2-4-8/types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example ```json { "address": EstimateAddressInput, - "cart_id": "abc123", + "cart_id": "xyz789", "shipping_method": ShippingMethodInput } ``` @@ -7580,8 +7573,8 @@ Lists the exchange rate. | Field Name | Description | |------------|-------------| -| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | +| `currency_to` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example @@ -7599,7 +7592,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID to assign to the cart. | #### 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 3a9d1a359..5b3676752 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 @@ -8,14 +8,14 @@ Defines a filter that matches the input exactly. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"]`. | +| `eq` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](/reference/graphql/2-4-8/types-q-s.md#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", + "eq": "xyz789", "in": ["abc123"] } ``` @@ -47,7 +47,7 @@ Defines a filter that performs a fuzzy search. | Input Field | Description | |-------------|-------------| -| `match` - [`String`](types-q-s.md#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` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -66,15 +66,15 @@ Defines a filter that matches a range of values, such as prices or dates. | Input Field | Description | |-------------|-------------| -| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | +| `from` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example ```json { "from": "abc123", - "to": "abc123" + "to": "xyz789" } ``` @@ -88,17 +88,17 @@ Defines a filter for an input string. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | +| `eq` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example ```json { - "eq": "abc123", - "in": ["abc123"], - "match": "xyz789" + "eq": "xyz789", + "in": ["xyz789"], + "match": "abc123" } ``` @@ -112,36 +112,36 @@ Defines the comparison operators that can be used in a filter. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Equals. | -| `finset` - [`[String]`](types-q-s.md#string) | | -| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](types-q-s.md#string) | Greater than. | -| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | -| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](types-q-s.md#string) | Less than. | -| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | -| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | -| `neq` - [`String`](types-q-s.md#string) | Not equal to. | -| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](types-q-s.md#string) | Not null. | -| `null` - [`String`](types-q-s.md#string) | Is null. | -| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | +| `eq` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `from` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Less than. | +| `lteq` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Not null. | +| `null` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Is null. | +| `to` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { "eq": "abc123", - "finset": ["abc123"], - "from": "abc123", + "finset": ["xyz789"], + "from": "xyz789", "gt": "abc123", - "gteq": "xyz789", + "gteq": "abc123", "in": ["xyz789"], "like": "abc123", - "lt": "xyz789", - "lteq": "abc123", - "moreq": "xyz789", + "lt": "abc123", + "lteq": "xyz789", + "moreq": "abc123", "neq": "xyz789", "nin": ["xyz789"], "notnull": "xyz789", @@ -160,15 +160,15 @@ A single FPT that can be applied to a product price. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | +| `amount` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -218,7 +218,7 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example @@ -236,12 +236,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | +| `customer_token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "xyz789"} +{"customer_token": "abc123"} ``` @@ -277,7 +277,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": 4} +{"negotiable_quote_uid": "4"} ``` @@ -290,7 +290,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](/reference/graphql/2-4-8/types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -308,9 +308,9 @@ Contains details about the gift card account. | Field Name | Description | |------------|-------------| -| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `balance` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -318,7 +318,7 @@ Contains details about the gift card account. { "balance": Money, "code": "xyz789", - "expiration_date": "xyz789" + "expiration_date": "abc123" } ``` @@ -332,7 +332,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The applied gift card code. | #### Example @@ -361,12 +361,12 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { - "attribute_id": 987, + "attribute_id": 123, "uid": 4, "value": 987.65, - "value_id": 123, + "value_id": 987, "website_id": 123, - "website_value": 987.65 + "website_value": 123.45 } ``` @@ -380,28 +380,28 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount and currency of the gift card. | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#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]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-8/types-c-e.md#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!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-q-s.md#string) | The message from the sender to the recipient. | +| `message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The message from the sender to the recipient. | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-8/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about an item in the cart. | | `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | -| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `recipient_email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -415,21 +415,21 @@ Contains details about a gift card that has been added to a cart. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": false, - "max_qty": 987.65, + "id": "xyz789", + "is_available": true, + "max_qty": 123.45, "message": "abc123", "min_qty": 987.65, - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "recipient_email": "xyz789", - "recipient_name": "xyz789", + "recipient_name": "abc123", "sender_email": "xyz789", - "sender_name": "xyz789", + "sender_name": "abc123", "uid": "4" } ``` @@ -442,13 +442,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#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`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -462,7 +462,7 @@ Contains details about a gift card that has been added to a cart. "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 } ``` @@ -474,13 +474,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -508,11 +508,11 @@ Contains details about a gift card. | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | +| `message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example @@ -520,9 +520,9 @@ Contains details about a gift card. { "message": "abc123", "recipient_email": "xyz789", - "recipient_name": "abc123", + "recipient_name": "xyz789", "sender_email": "abc123", - "sender_name": "abc123" + "sender_name": "xyz789" } ``` @@ -536,13 +536,13 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | +| `amount` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -550,9 +550,9 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "abc123", + "message": "abc123", + "recipient_email": "abc123", + "recipient_name": "xyz789", "sender_email": "abc123", "sender_name": "xyz789" } @@ -566,20 +566,20 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#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`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/2-4-8/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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. | @@ -587,36 +587,36 @@ Contains details about the sender, recipient, and amount of a gift card. | `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]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/2-4-8/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the order item. | #### Example ```json { "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", + "product_sku": "abc123", + "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 123.45, + "quantity_canceled": 987.65, "quantity_invoiced": 987.65, "quantity_ordered": 123.45, "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, + "quantity_return_requested": 987.65, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -630,114 +630,114 @@ Defines properties of a gift card. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](types-a-b.md#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `activity` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `allow_message` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](/reference/graphql/2-4-8/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-8/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `gender` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](/reference/graphql/2-4-8/types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-8/types-k-p.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `new_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-8/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-8/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-8/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-8/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](/reference/graphql/2-4-8/types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | | `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#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`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-8/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/2-4-8/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-8/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-8/types-t-z.md#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, + "activity": "abc123", + "allow_message": false, "allow_open_amount": true, - "attribute_set_id": 987, + "attribute_set_id": 123, "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "xyz789", - "climate": "abc123", + "category_gear": "abc123", + "climate": "xyz789", "collar": "xyz789", "color": 987, "country_of_manufacture": "xyz789", @@ -745,14 +745,14 @@ Defines properties of a gift card. "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "eco_collection": 987, - "erin_recommends": 987, - "features_bags": "abc123", - "format": 123, - "gender": "xyz789", + "eco_collection": 123, + "erin_recommends": 123, + "features_bags": "xyz789", + "format": 987, + "gender": "abc123", "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": false, - "gift_wrapping_available": false, + "gift_message_available": true, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", @@ -762,24 +762,24 @@ Defines properties of a gift card. "is_returnable": "abc123", "lifetime": 123, "manufacturer": 123, - "material": "abc123", + "material": "xyz789", "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "message_max_length": 987, - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "abc123", + "min_sale_qty": 987.65, + "name": "xyz789", "new": 123, "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "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", + "options_container": "xyz789", "pattern": "abc123", "performance_fabric": 987, "price": ProductPrices, @@ -789,7 +789,7 @@ Defines properties of a gift card. "purpose": 123, "quantity": 123.45, "rating_summary": 987.65, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", "review_count": 987, @@ -797,22 +797,22 @@ Defines properties of a gift card. "rules": [CatalogRule], "sale": 987, "short_description": ComplexTextValue, - "size": 123, - "sku": "abc123", - "sleeve": "abc123", + "size": 987, + "sku": "xyz789", + "sleeve": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 123.45, - "special_to_date": "xyz789", - "staged": false, + "special_to_date": "abc123", + "staged": true, "stock_status": "IN_STOCK", "strap_bags": "abc123", "style_bags": "abc123", "style_bottom": "abc123", - "style_general": "abc123", - "swatch_image": "abc123", + "style_general": "xyz789", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", @@ -820,7 +820,7 @@ Defines properties of a gift card. "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "abc123", - "url_path": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], @@ -838,9 +838,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -866,10 +866,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -877,11 +877,11 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_shipped": 987.65 } ``` @@ -916,12 +916,12 @@ A single gift card added to a wish list. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -930,11 +930,11 @@ A single gift card added to a wish list. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "gift_card_options": GiftCardOptions, "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -948,17 +948,17 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | Sender name | -| `message` - [`String!`](types-q-s.md#string) | Gift message text | -| `to` - [`String!`](types-q-s.md#string) | Recipient name | +| `from` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Sender name | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Gift message text | +| `to` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "xyz789", + "from": "abc123", "message": "abc123", - "to": "abc123" + "to": "xyz789" } ``` @@ -972,9 +972,9 @@ Defines a gift message. | Input Field | Description | |-------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | -| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | -| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | +| `from` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the recepient. | #### Example @@ -996,12 +996,12 @@ Contains prices for gift wrapping options. | Field Name | Description | |------------|-------------| -| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_items_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | -| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | -| `gift_wrapping_for_order_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | -| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | -| `printed_card_incl_tax` - [`Money`](types-k-p.md#money) | Price for the printed card including tax. | +| `gift_wrapping_for_items` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Price for the printed card including tax. | #### Example @@ -1026,15 +1026,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-q-s.md#string) | The name of the event. | +| `event_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the event. | | `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](types-q-s.md#string) | The customer who created the gift registry. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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`](types-c-e.md#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `shipping_address` - [`CustomerAddress`](/reference/graphql/2-4-8/types-c-e.md#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. | @@ -1054,7 +1054,7 @@ Contains details about a gift registry. "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } ``` @@ -1068,16 +1068,16 @@ Contains details about a gift registry. |------------|-------------| | `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!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": 4, + "code": "4", "group": "EVENT_INFORMATION", - "label": "xyz789", + "label": "abc123", "value": "abc123" } ``` @@ -1116,12 +1116,15 @@ Defines a dynamic attribute. | Input Field | Description | |-------------|-------------| | `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example ```json -{"code": 4, "value": "xyz789"} +{ + "code": "4", + "value": "abc123" +} ``` @@ -1133,8 +1136,8 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1147,7 +1150,7 @@ Defines a dynamic attribute. ```json { - "code": "4", + "code": 4, "label": "xyz789", "value": "abc123" } @@ -1161,11 +1164,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Example @@ -1175,8 +1178,8 @@ Defines a dynamic attribute. "attribute_group": "xyz789", "code": "4", "input_type": "abc123", - "is_required": false, - "label": "abc123", + "is_required": true, + "label": "xyz789", "sort_order": 987 } ``` @@ -1189,11 +1192,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1209,9 +1212,9 @@ Defines a dynamic attribute. "attribute_group": "abc123", "code": "4", "input_type": "abc123", - "is_required": false, + "is_required": true, "label": "xyz789", - "sort_order": 987 + "sort_order": 123 } ``` @@ -1223,9 +1226,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#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. | @@ -1234,12 +1237,12 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", - "note": "abc123", + "created_at": "xyz789", + "note": "xyz789", "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "quantity_fulfilled": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -1251,9 +1254,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#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. | @@ -1271,7 +1274,7 @@ Defines a dynamic attribute. "created_at": "xyz789", "note": "xyz789", "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "quantity_fulfilled": 987.65, "uid": 4 } @@ -1287,20 +1290,20 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-8/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example ```json { - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -1318,7 +1321,7 @@ Contains details about an error that occurred when processing a gift registry it | `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!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1326,9 +1329,9 @@ Contains details about an error that occurred when processing a gift registry it ```json { "code": "OUT_OF_STOCK", - "gift_registry_item_uid": 4, - "gift_registry_uid": 4, - "message": "abc123", + "gift_registry_item_uid": "4", + "gift_registry_uid": "4", + "message": "xyz789", "product_uid": "4" } ``` @@ -1369,7 +1372,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/2-4-8/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1407,9 +1410,9 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1420,9 +1423,9 @@ Contains details about a registrant. GiftRegistryRegistrantDynamicAttribute ], "email": "xyz789", - "firstname": "xyz789", - "lastname": "xyz789", - "uid": 4 + "firstname": "abc123", + "lastname": "abc123", + "uid": "4" } ``` @@ -1435,8 +1438,8 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A corresponding value for the code. | #### Example @@ -1458,12 +1461,12 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | -| `event_title` - [`String!`](types-q-s.md#string) | The title given to the event. | +| `event_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The title given to the event. | | `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](types-q-s.md#string) | The location of the event. | -| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | -| `type` - [`String`](types-q-s.md#string) | The type of event being held. | +| `location` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of event being held. | #### Example @@ -1471,9 +1474,9 @@ Contains the results of a gift registry search. { "event_date": "xyz789", "event_title": "abc123", - "gift_registry_uid": 4, - "location": "abc123", - "name": "abc123", + "gift_registry_uid": "4", + "location": "xyz789", + "name": "xyz789", "type": "abc123" } ``` @@ -1488,7 +1491,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](/reference/graphql/2-4-8/types-c-e.md#customeraddressinput) | Defines the shipping address for this gift registry. | | `address_id` - [`ID`](#id) | The ID assigned to this customer address. | #### Example @@ -1527,7 +1530,7 @@ Contains details about a gift registry type. | 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!`](types-q-s.md#string) | The label assigned to the gift registry type on the Admin. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -1552,21 +1555,21 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](types-q-s.md#string) | The name of the gift wrapping design. | +| `design` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-k-p.md#money) | The gift wrapping price. | +| `price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example ```json { - "design": "abc123", + "design": "xyz789", "id": "4", "image": GiftWrappingImage, "price": Money, - "uid": "4" + "uid": 4 } ``` @@ -1580,14 +1583,14 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | -| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The gift wrapping preview image URL. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "url": "abc123" } ``` @@ -1600,17 +1603,17 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | +| `color` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](types-q-s.md#string) | The button type | +| `type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The button type | #### Example ```json { "color": "abc123", - "height": 987, - "type": "xyz789" + "height": 123, + "type": "abc123" } ``` @@ -1623,28 +1626,28 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| | `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-8/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/2-4-8/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": GooglePayButtonStyles, - "code": "xyz789", - "is_visible": false, + "code": "abc123", + "is_visible": true, "payment_intent": "abc123", "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" } ``` @@ -1658,9 +1661,9 @@ Google Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | PayPal order ID | #### Example @@ -1682,103 +1685,103 @@ Defines a grouped product, which consists of simple standalone products that are | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `activity` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](/reference/graphql/2-4-8/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-8/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `gender` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `new_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for new product listings. | | `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `options_container` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `price` - [`ProductPrices`](/reference/graphql/2-4-8/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-8/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-8/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](/reference/graphql/2-4-8/types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | | `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#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`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-8/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/2-4-8/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-8/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-8/types-t-z.md#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", + "activity": "xyz789", "attribute_set_id": 123, "canonical_url": "xyz789", "categories": [CategoryInterface], "category_gear": "abc123", - "climate": "abc123", - "collar": "abc123", + "climate": "xyz789", + "collar": "xyz789", "color": 987, "country_of_manufacture": "xyz789", "created_at": "xyz789", @@ -1787,76 +1790,76 @@ Defines a grouped product, which consists of simple standalone products that are "description": ComplexTextValue, "eco_collection": 987, "erin_recommends": 123, - "features_bags": "abc123", - "format": 123, - "gender": "xyz789", + "features_bags": "xyz789", + "format": 987, + "gender": "abc123", "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "items": [GroupedProductItem], "manufacturer": 123, - "material": "abc123", - "max_sale_qty": 987.65, + "material": "xyz789", + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_title": "xyz789", "min_sale_qty": 123.45, - "name": "abc123", + "name": "xyz789", "new": 987, - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, - "options_container": "xyz789", - "pattern": "xyz789", - "performance_fabric": 123, + "options_container": "abc123", + "pattern": "abc123", + "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 123, - "quantity": 987.65, + "purpose": 987, + "quantity": 123.45, "rating_summary": 123.45, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "xyz789", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], "sale": 123, "short_description": ComplexTextValue, "size": 987, "sku": "abc123", - "sleeve": "xyz789", + "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 987.65, - "special_to_date": "xyz789", + "special_to_date": "abc123", "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", + "strap_bags": "abc123", "style_bags": "abc123", "style_bottom": "xyz789", - "style_general": "abc123", + "style_general": "xyz789", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": "4", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", - "url_path": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -1871,7 +1874,7 @@ Contains information about an individual grouped product item. | Field Name | Description | |------------|-------------| | `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example @@ -1880,7 +1883,7 @@ Contains information about an individual grouped product item. { "position": 987, "product": ProductInterface, - "qty": 123.45 + "qty": 987.65 } ``` @@ -1894,11 +1897,11 @@ A grouped product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the item. | | `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -1907,10 +1910,10 @@ A grouped product wish list item. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1924,8 +1927,8 @@ Input to retrieve a guest order based on token. | Input Field | Description | |-------------|-------------| -| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | -| `token` - [`String!`](types-q-s.md#string) | Order token. | +| `reason` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Cancellation reason. | +| `token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Order token. | #### Example @@ -1944,32 +1947,32 @@ Input to retrieve a guest order based on token. | Field Name | Description | |------------|-------------| -| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds` - [`Boolean`](types-a-b.md#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `cc_vault_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-8/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/2-4-8/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "cc_vault_code": "abc123", - "code": "xyz789", - "is_vault_enabled": true, - "is_visible": false, + "cc_vault_code": "xyz789", + "code": "abc123", + "is_vault_enabled": false, + "is_visible": true, "payment_intent": "abc123", - "payment_source": "xyz789", + "payment_source": "abc123", "requires_card_details": false, "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds": true, "three_ds_mode": "OFF", "title": "xyz789" @@ -1986,26 +1989,26 @@ Hosted Fields payment inputs | Input Field | Description | |-------------|-------------| -| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | -| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `holderName` - [`String`](types-q-s.md#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `cardBin` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | PayPal order ID | #### Example ```json { "cardBin": "abc123", - "cardExpiryMonth": "xyz789", + "cardExpiryMonth": "abc123", "cardExpiryYear": "abc123", - "cardLast4": "abc123", + "cardLast4": "xyz789", "holderName": "xyz789", - "is_active_payment_token_enabler": false, + "is_active_payment_token_enabler": true, "payment_source": "xyz789", "payments_order_id": "abc123", "paypal_order_id": "xyz789" @@ -2022,14 +2025,14 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](/reference/graphql/2-4-8/types-q-s.md#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": "abc123", + "cancel_url": "xyz789", "return_url": "abc123" } ``` @@ -2044,12 +2047,12 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The secure URL generated by PayPal. | #### Example ```json -{"secure_form_url": "xyz789"} +{"secure_form_url": "abc123"} ``` @@ -2062,12 +2065,12 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -2080,14 +2083,14 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | A parameter name. | -| `value` - [`String`](types-q-s.md#string) | A parameter value. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A parameter name. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A parameter value. | #### Example ```json { - "name": "abc123", + "name": "xyz789", "value": "abc123" } ``` @@ -2116,8 +2119,8 @@ When expected as an input type, any string (such as `"4"`) or integer | Field Name | Description | |------------|-------------| -| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `thumbnail` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -2158,8 +2161,8 @@ List of templates/filters applied to customer attribute input. | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `code` - [`CartUserInputErrorType!`](/reference/graphql/2-4-8/types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | | `quantity` - [`Float`](#float) | Amount of available stock | #### Example @@ -2167,7 +2170,7 @@ List of templates/filters applied to customer attribute input. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", + "message": "abc123", "quantity": 987.65 } ``` @@ -2182,7 +2185,7 @@ values. Int can represent values between -(2^31) and 2^31 - 1. #### Example ```json -987 +123 ``` @@ -2195,12 +2198,12 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -2213,10 +2216,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-8/types-q-s.md#salescommentitem) | Comments on the invoice. | | `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | | `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | +| `number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2224,7 +2227,7 @@ Contains invoice details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [InvoiceItemInterface], "number": "xyz789", "total": InvoiceTotal @@ -2239,12 +2242,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2254,10 +2257,10 @@ Contains invoice details. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -2271,20 +2274,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | -| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](/reference/graphql/2-4-8/types-a-b.md#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](/reference/graphql/2-4-8/types-c-e.md#downloadableinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2295,7 +2298,7 @@ Contains detailes about invoiced items. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_invoiced": 987.65 @@ -2312,14 +2315,14 @@ Contains price details from an invoice. | Field Name | Description | |------------|-------------| -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | +| `base_grand_total` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-8/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-8/types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2346,7 +2349,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2364,7 +2367,7 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example @@ -2382,7 +2385,7 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example @@ -2400,12 +2403,12 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2418,7 +2421,7 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example @@ -2436,23 +2439,23 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](types-q-s.md#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | Note text. | +| `note` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example ```json { - "created_at": "xyz789", + "created_at": "abc123", "creator_id": 987, - "creator_type": 987, + "creator_type": 123, "negotiable_quote_item_uid": "4", "note": "abc123", - "note_uid": "4" + "note_uid": 4 } ``` @@ -2467,7 +2470,7 @@ A list of options of the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](types-q-s.md#string) | The label of the option. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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. | @@ -2475,9 +2478,9 @@ A list of options of the selected bundle product. ```json { - "id": "4", + "id": 4, "label": "xyz789", - "uid": "4", + "uid": 4, "values": [ItemSelectedBundleOptionValue] } ``` @@ -2493,9 +2496,9 @@ A list of values for the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | -| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the child bundle product. | +| `price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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. | @@ -2505,9 +2508,9 @@ A list of values for the selected bundle product. { "id": 4, "price": Money, - "product_name": "abc123", + "product_name": "xyz789", "product_sku": "xyz789", - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md index 77d5c5177..eda9633c8 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md @@ -8,8 +8,8 @@ Contains a key-value pair. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | -| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value part of the key/value pair. | #### Example @@ -31,17 +31,17 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| | `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | +| `filter_items_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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", + "filter_items_count": 987, + "name": "xyz789", "request_var": "xyz789" } ``` @@ -54,17 +54,17 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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", - "value_string": "xyz789" + "items_count": 123, + "label": "xyz789", + "value_string": "abc123" } ``` @@ -76,24 +76,24 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#swatchlayerfilteritem) | +| [`SwatchLayerFilterItem`](/reference/graphql/2-4-8/types-q-s.md#swatchlayerfilteritem) | #### Example ```json { - "items_count": 987, + "items_count": 123, "label": "xyz789", - "value_string": "abc123" + "value_string": "xyz789" } ``` @@ -107,17 +107,17 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `note` - [`String`](types-q-s.md#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `note` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "note": "xyz789", - "quote_item_uid": "4", - "quote_uid": "4" + "quote_item_uid": 4, + "quote_uid": 4 } ``` @@ -132,14 +132,14 @@ Defines characteristics about images and videos associated with a specific produ | Field Name | Description | |------------|-------------| | `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | -| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -147,14 +147,14 @@ Defines characteristics about images and videos associated with a specific produ ```json { "content": ProductMediaGalleryEntriesContent, - "disabled": true, - "file": "abc123", + "disabled": false, + "file": "xyz789", "id": 123, - "label": "abc123", - "media_type": "abc123", - "position": 987, - "types": ["abc123"], - "uid": "4", + "label": "xyz789", + "media_type": "xyz789", + "position": 123, + "types": ["xyz789"], + "uid": 4, "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -169,10 +169,10 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -186,9 +186,9 @@ Contains basic information about a product image or video. ```json { "disabled": false, - "label": "xyz789", - "position": 123, - "url": "abc123" + "label": "abc123", + "position": 987, + "url": "xyz789" } ``` @@ -200,12 +200,12 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{"type": "xyz789"} +{"type": "abc123"} ``` @@ -216,14 +216,14 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `layout` - [`String`](types-q-s.md#string) | The message layout | +| `layout` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "layout": "abc123", + "layout": "xyz789", "logo": MessageStyleLogo } ``` @@ -238,8 +238,8 @@ Defines a monetary value, including a numeric value and a currency code. | Field Name | Description | |------------|-------------| -| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | +| `currency` - [`CurrencyEnum`](/reference/graphql/2-4-8/types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | A number expressing a monetary value. | #### Example @@ -257,9 +257,9 @@ Contains the customer's gift registry and any errors encountered. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](/reference/graphql/2-4-8/types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -281,7 +281,7 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example @@ -299,8 +299,8 @@ Output of the request to move items to another requisition list. | Field Name | Description | |------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | +| `destination_requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -321,16 +321,16 @@ Move Line Item to Requisition List. | Input Field | Description | |-------------|-------------| -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | +| `quote_item_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json { - "quote_item_uid": 4, - "quote_uid": "4", + "quote_item_uid": "4", + "quote_uid": 4, "requisition_list_uid": "4" } ``` @@ -363,9 +363,9 @@ Contains the source and target wish lists after moving products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -387,23 +387,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/2-4-8/types-a-b.md#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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](types-q-s.md#string) | The email address of the company user. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/2-4-8/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](/reference/graphql/2-4-8/types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-f-i.md#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -413,12 +413,12 @@ Contains details about a negotiable quote. "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], @@ -439,15 +439,15 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The address country code. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The address country code. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the region. | #### Example ```json { "code": "abc123", - "label": "abc123" + "label": "xyz789" } ``` @@ -461,17 +461,17 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company name. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example @@ -479,15 +479,15 @@ Defines the billing or shipping address to be applied to the cart. { "city": "abc123", "company": "xyz789", - "country_code": "xyz789", + "country_code": "abc123", "firstname": "xyz789", - "lastname": "abc123", + "lastname": "xyz789", "postcode": "xyz789", - "region": "abc123", + "region": "xyz789", "region_id": 123, "save_in_address_book": true, - "street": ["xyz789"], - "telephone": "xyz789" + "street": ["abc123"], + "telephone": "abc123" } ``` @@ -499,15 +499,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -520,14 +520,14 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "xyz789" } ``` @@ -542,9 +542,9 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The address region code. | -| `label` - [`String`](types-q-s.md#string) | The display name of the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The address region code. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example @@ -564,29 +564,29 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's telephone number. | #### Example ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", + "firstname": "abc123", "lastname": "xyz789", "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" + "street": ["abc123"], + "telephone": "abc123" } ``` @@ -601,9 +601,9 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example @@ -611,7 +611,7 @@ Defines the billing address. { "address": NegotiableQuoteAddressInput, "customer_address_uid": "4", - "same_as_shipping": true, + "same_as_shipping": false, "use_for_shipping": true } ``` @@ -627,19 +627,19 @@ Contains a single plain text comment from either the buyer or seller. | Field Name | Description | |------------|-------------| | `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the comment was created. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the comment was created. | | `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | +| `text` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { "author": NegotiableQuoteUser, - "created_at": "xyz789", + "created_at": "abc123", "creator_type": "BUYER", - "text": "xyz789", + "text": "abc123", "uid": 4 } ``` @@ -671,7 +671,7 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | +| `comment` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The comment provided by the buyer. | #### Example @@ -689,16 +689,16 @@ Contains custom log entries added by third-party extensions. | Field Name | Description | |------------|-------------| -| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | -| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | -| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | +| `new_value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { "new_value": "abc123", - "old_value": "xyz789", + "old_value": "abc123", "title": "abc123" } ``` @@ -713,8 +713,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -765,12 +765,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "abc123"} +{"comment": "xyz789"} ``` @@ -786,8 +786,8 @@ Contains details about a change for a negotiable quote. | `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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -830,14 +830,14 @@ Contains a new expiration date and the previous date. | Field Name | Description | |------------|-------------| -| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | +| `new_expiration` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "new_expiration": "abc123", + "new_expiration": "xyz789", "old_expiration": "xyz789" } ``` @@ -852,7 +852,7 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](/reference/graphql/2-4-8/types-f-i.md#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 @@ -933,12 +933,12 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -951,8 +951,8 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example @@ -970,8 +970,8 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | Payment method code | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -992,18 +992,18 @@ Contains a reference document link for a negotiable quote template. | Field Name | Description | |------------|-------------| -| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | -| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | -| `link_id` - [`ID!`](types-f-i.md#id) | The unique ID of a reference document link. | -| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | +| `document_identifier` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL of the reference document. | #### Example ```json { - "document_identifier": "abc123", - "document_name": "abc123", - "link_id": 4, + "document_identifier": "xyz789", + "document_name": "xyz789", + "link_id": "4", "reference_document_url": "xyz789" } ``` @@ -1016,17 +1016,17 @@ Contains a reference document link for a negotiable quote template. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/2-4-8/types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `selected_shipping_method` - [`SelectedShippingMethod`](/reference/graphql/2-4-8/types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's telephone number. | #### Example @@ -1034,15 +1034,15 @@ Contains a reference document link for a negotiable quote template. { "available_shipping_methods": [AvailableShippingMethod], "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", - "lastname": "abc123", + "lastname": "xyz789", "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, "street": ["abc123"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1057,15 +1057,15 @@ Defines shipping addresses for the negotiable quote. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", + "customer_address_uid": 4, "customer_notes": "xyz789" } ``` @@ -1080,7 +1080,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1143,21 +1143,21 @@ Contains details about a negotiable quote template. |------------|-------------| | `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!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `expiration_date` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/2-4-8/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](/reference/graphql/2-4-8/types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](/reference/graphql/2-4-8/types-c-e.md#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!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | +| `status` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The total number of items in the negotiable quote template. | #### Example @@ -1171,7 +1171,7 @@ Contains details about a negotiable quote template. "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -1195,8 +1195,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | +| `state` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1217,40 +1217,40 @@ Contains data for a negotiable quote template in a grid. | Field Name | Description | |------------|-------------| -| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | -| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | -| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | -| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | -| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `activated_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "activated_at": "xyz789", + "activated_at": "abc123", "company_name": "abc123", - "expiration_date": "xyz789", - "is_min_max_qty_used": true, + "expiration_date": "abc123", + "is_min_max_qty_used": false, "last_shared_at": "abc123", - "max_order_commitment": 987, + "max_order_commitment": 123, "min_negotiated_grand_total": 123.45, "min_order_commitment": 987, "name": "abc123", - "orders_placed": 123, + "orders_placed": 987, "sales_rep_name": "abc123", - "state": "xyz789", + "state": "abc123", "status": "xyz789", - "submitted_by": "abc123", + "submitted_by": "xyz789", "template_id": "4" } ``` @@ -1265,15 +1265,15 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `item_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-f-i.md#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!`](/reference/graphql/2-4-8/types-f-i.md#float) | The new quantity of the negotiable quote item. | #### Example ```json -{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65} +{"item_id": 4, "max_qty": 987.65, "min_qty": 123.45, "quantity": 987.65} ``` @@ -1286,19 +1286,19 @@ Defines the reference document link to add to a negotiable quote template. | Input Field | Description | |-------------|-------------| -| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | -| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | -| `link_id` - [`ID`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | -| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | +| `document_identifier` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL of the reference document. | #### Example ```json { "document_identifier": "abc123", - "document_name": "xyz789", + "document_name": "abc123", "link_id": "4", - "reference_document_url": "abc123" + "reference_document_url": "xyz789" } ``` @@ -1313,16 +1313,16 @@ Defines shipping addresses for the negotiable quote template. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "abc123" + "customer_address_uid": "4", + "customer_notes": "xyz789" } ``` @@ -1336,7 +1336,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1373,9 +1373,9 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-8/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1396,7 +1396,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1407,7 +1407,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1420,12 +1420,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1438,14 +1438,14 @@ A limited view of a Buyer or Seller in the negotiable quote process. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The buyer's or seller's last name. | #### Example ```json { - "firstname": "abc123", + "firstname": "xyz789", "lastname": "xyz789" } ``` @@ -1461,9 +1461,9 @@ Contains a list of negotiable that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-8/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1486,16 +1486,13 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | -| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json -{ - "message": "xyz789", - "uid": "4" -} +{"message": "xyz789", "uid": 4} ``` @@ -1508,12 +1505,12 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -1526,14 +1523,14 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json { - "order_id": "abc123", + "order_id": "xyz789", "order_number": "xyz789" } ``` @@ -1568,42 +1565,42 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `fax` - [`String`](types-q-s.md#string) | The fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `city` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The city or town. | +| `company` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](/reference/graphql/2-4-8/types-c-e.md#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "abc123", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": "abc123", - "region_id": "4", - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", + "region_id": 4, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", "vat_id": "xyz789" } ``` @@ -1616,11 +1613,11 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | First name of the customer | -| `lastname` - [`String`](types-q-s.md#string) | Last name of the customer | -| `middlename` - [`String`](types-q-s.md#string) | Middle name of the customer | -| `prefix` - [`String`](types-q-s.md#string) | Prefix of the customer | -| `suffix` - [`String`](types-q-s.md#string) | Suffix of the customer | +| `firstname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | First name of the customer | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Last name of the customer | +| `middlename` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Middle name of the customer | +| `prefix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Prefix of the customer | +| `suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Suffix of the customer | #### Example @@ -1628,9 +1625,9 @@ Contains detailed information about an order's billing and shipping addresses. { "firstname": "abc123", "lastname": "abc123", - "middlename": "xyz789", - "prefix": "abc123", - "suffix": "xyz789" + "middlename": "abc123", + "prefix": "xyz789", + "suffix": "abc123" } ``` @@ -1644,17 +1641,17 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | -| `lastname` - [`String!`](types-q-s.md#string) | Order billing address lastname. | -| `number` - [`String!`](types-q-s.md#string) | Order number. | +| `email` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Order billing address email. | +| `lastname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Order billing address lastname. | +| `number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Order number. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "lastname": "abc123", - "number": "abc123" + "number": "xyz789" } ``` @@ -1666,55 +1663,55 @@ Input to retrieve an order based on details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the order item. | #### Example ```json { "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "abc123", - "product_url_key": "abc123", + "product_sku": "abc123", + "product_type": "xyz789", + "product_url_key": "xyz789", "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, + "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, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -1728,37 +1725,37 @@ Order item details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`ConfigurableOrderItem`](types-c-e.md#configurableorderitem) | -| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | -| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | -| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | +| [`ConfigurableOrderItem`](/reference/graphql/2-4-8/types-c-e.md#configurableorderitem) | +| [`BundleOrderItem`](/reference/graphql/2-4-8/types-a-b.md#bundleorderitem) | +| [`DownloadableOrderItem`](/reference/graphql/2-4-8/types-c-e.md#downloadableorderitem) | +| [`GiftCardOrderItem`](/reference/graphql/2-4-8/types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1766,7 +1763,7 @@ Order item details. ```json { "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -1775,12 +1772,12 @@ Order item details. "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "product_url_key": "abc123", + "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, @@ -1800,14 +1797,14 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The name of the option. | -| `value` - [`String!`](types-q-s.md#string) | The value of the option. | +| `label` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -1820,8 +1817,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](types-f-i.md#fixedproducttax) | | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -1861,16 +1858,16 @@ Contains details about the payment method used to pay for the order. | Field Name | Description | |------------|-------------| | `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | -| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example ```json { "additional_data": [KeyValue], - "name": "xyz789", - "type": "abc123" + "name": "abc123", + "type": "xyz789" } ``` @@ -1884,20 +1881,20 @@ Contains order shipment details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/2-4-8/types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](/reference/graphql/2-4-8/types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](/reference/graphql/2-4-8/types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example ```json { "comments": [SalesCommentItem], - "id": "4", + "id": 4, "items": [ShipmentItemInterface], - "number": "xyz789", + "number": "abc123", "tracking": [ShipmentTracking] } ``` @@ -1912,7 +1909,7 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](types-q-s.md#string) | Order token. | +| `token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Order token. | #### Example @@ -1931,14 +1928,14 @@ Contains details about the sales total amounts used to calculate the final price | Field Name | Description | |------------|-------------| | `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | -| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | | +| `discounts` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/2-4-8/types-f-i.md#giftoptionsprices) | | | `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the order. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/2-4-8/types-q-s.md#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]`](types-t-z.md#taxitem) | The order tax details. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-8/types-t-z.md#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. | @@ -1976,14 +1973,14 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { - "payer_id": "abc123", + "payer_id": "xyz789", "token": "abc123" } ``` @@ -1998,15 +1995,15 @@ A set of relative URLs that PayPal uses in response to various actions during th | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](/reference/graphql/2-4-8/types-q-s.md#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!`](/reference/graphql/2-4-8/types-q-s.md#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", + "cancel_url": "abc123", "error_url": "xyz789", "return_url": "xyz789" } @@ -2042,9 +2039,9 @@ Contains information used to generate PayPal iframe for transaction. Applies to | Field Name | Description | |------------|-------------| | `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | +| `paypal_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example @@ -2052,7 +2049,7 @@ Contains information used to generate PayPal iframe for transaction. Applies to { "mode": "TEST", "paypal_url": "abc123", - "secure_token": "xyz789", + "secure_token": "abc123", "secure_token_id": "xyz789" } ``` @@ -2067,12 +2064,12 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -2085,8 +2082,8 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | Input Field | Description | |-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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. | +| `cc_details` - [`CreditCardDetailsInput!`](/reference/graphql/2-4-8/types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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 @@ -2107,8 +2104,8 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The payload returned from PayPal. | #### Example @@ -2127,7 +2124,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -2145,14 +2142,14 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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", + "cart_id": "xyz789", "urls": PayflowProUrlInput } ``` @@ -2167,17 +2164,17 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](/reference/graphql/2-4-8/types-q-s.md#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!`](/reference/graphql/2-4-8/types-q-s.md#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": "abc123" + "error_url": "xyz789", + "return_url": "xyz789" } ``` @@ -2191,31 +2188,31 @@ Contains payment fields that are common to all types of payment methods. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-8/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | -| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | -| [`ApplePayConfig`](types-a-b.md#applepayconfig) | -| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | +| [`HostedFieldsConfig`](/reference/graphql/2-4-8/types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](/reference/graphql/2-4-8/types-q-s.md#smartbuttonsconfig) | +| [`ApplePayConfig`](/reference/graphql/2-4-8/types-a-b.md#applepayconfig) | +| [`GooglePayConfig`](/reference/graphql/2-4-8/types-f-i.md#googlepayconfig) | #### Example ```json { - "code": "xyz789", + "code": "abc123", "is_visible": false, "payment_intent": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "title": "xyz789" } ``` @@ -2230,10 +2227,10 @@ Retrieves the payment configuration for a given location | Field Name | Description | |------------|-------------| -| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | -| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | +| `apple_pay` - [`ApplePayConfig`](/reference/graphql/2-4-8/types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `google_pay` - [`GooglePayConfig`](/reference/graphql/2-4-8/types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](/reference/graphql/2-4-8/types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](/reference/graphql/2-4-8/types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2278,27 +2275,27 @@ Defines the payment method. | Input Field | Description | |-------------|-------------| -| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_ach_direct_debit` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_applepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | -| `braintree_googlepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_paypal` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_paypal_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](types-f-i.md#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `braintree` - [`BraintreeInput`](/reference/graphql/2-4-8/types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](/reference/graphql/2-4-8/types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-8/types-a-b.md#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-8/types-a-b.md#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](/reference/graphql/2-4-8/types-a-b.md#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-8/types-a-b.md#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](/reference/graphql/2-4-8/types-a-b.md#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](/reference/graphql/2-4-8/types-a-b.md#braintreevaultinput) | | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](/reference/graphql/2-4-8/types-f-i.md#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`](types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#vaultmethodinput) | Required input for vault | +| `payflowpro_cc_vault` - [`VaultTokenInput`](/reference/graphql/2-4-8/types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](/reference/graphql/2-4-8/types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](/reference/graphql/2-4-8/types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](/reference/graphql/2-4-8/types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](/reference/graphql/2-4-8/types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](/reference/graphql/2-4-8/types-t-z.md#vaultmethodinput) | Required input for vault | | `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `purchase_order_number` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -2324,7 +2321,7 @@ Defines the payment method. "payment_services_paypal_smart_buttons": SmartButtonMethodInput, "payment_services_paypal_vault": VaultMethodInput, "paypal_express": PaypalExpressInput, - "purchase_order_number": "xyz789" + "purchase_order_number": "abc123" } ``` @@ -2338,16 +2335,16 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The order ID generated by Payment Services | | `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `status` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The status of the payment order | #### Example ```json { - "id": "abc123", + "id": "xyz789", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, "status": "abc123" @@ -2362,8 +2359,8 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](/reference/graphql/2-4-8/types-q-s.md#sdkparams) | The payment SDK parameters | #### Example @@ -2382,7 +2379,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | +| `card` - [`Card`](/reference/graphql/2-4-8/types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2400,7 +2397,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](types-c-e.md#cardpaymentsourceinput) | The card payment source information | +| `card` - [`CardPaymentSourceInput!`](/reference/graphql/2-4-8/types-c-e.md#cardpaymentsourceinput) | The card payment source information | #### Example @@ -2418,7 +2415,7 @@ The payment source information | Field Name | Description | |------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](types-c-e.md#cardpaymentsourceoutput) | The card payment source information | +| `card` - [`CardPaymentSourceOutput!`](/reference/graphql/2-4-8/types-c-e.md#cardpaymentsourceoutput) | The card payment source information | #### Example @@ -2436,16 +2433,16 @@ The stored payment method available to the customer. | Field Name | Description | |------------|-------------| -| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | +| `details` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "details": "xyz789", + "details": "abc123", "payment_method_code": "xyz789", "public_hash": "xyz789", "type": "card" @@ -2481,15 +2478,15 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { "payer_id": "xyz789", - "token": "xyz789" + "token": "abc123" } ``` @@ -2503,19 +2500,19 @@ Defines the attributes required to receive a payment token for Express Checkout | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | -| `express_button` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | +| `use_paypal_credit` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "code": "abc123", - "express_button": false, + "express_button": true, "urls": PaypalExpressUrlsInput, "use_paypal_credit": false } @@ -2532,14 +2529,14 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | Field Name | Description | |------------|-------------| | `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | +| `token` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The token returned by PayPal. | #### Example ```json { "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" + "token": "abc123" } ``` @@ -2553,15 +2550,15 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | Field Name | Description | |------------|-------------| -| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | +| `edit` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL to the PayPal login page. | #### Example ```json { "edit": "xyz789", - "start": "xyz789" + "start": "abc123" } ``` @@ -2575,19 +2572,19 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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`](/reference/graphql/2-4-8/types-q-s.md#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!`](/reference/graphql/2-4-8/types-q-s.md#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`](/reference/graphql/2-4-8/types-q-s.md#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", + "cancel_url": "abc123", + "pending_url": "xyz789", "return_url": "xyz789", - "success_url": "xyz789" + "success_url": "abc123" } ``` @@ -2601,22 +2598,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Possible Types | PhysicalProductInterface Types | |----------------| -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-8/types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-8/types-c-e.md#configurableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-8/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-8/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-8/types-f-i.md#groupedproduct) | #### Example ```json -{"weight": 987.65} +{"weight": 123.45} ``` @@ -2629,33 +2626,33 @@ Defines Pickup Location information. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | | -| `contact_name` - [`String`](types-q-s.md#string) | | -| `country_id` - [`String`](types-q-s.md#string) | | -| `description` - [`String`](types-q-s.md#string) | | -| `email` - [`String`](types-q-s.md#string) | | -| `fax` - [`String`](types-q-s.md#string) | | -| `latitude` - [`Float`](types-f-i.md#float) | | -| `longitude` - [`Float`](types-f-i.md#float) | | -| `name` - [`String`](types-q-s.md#string) | | -| `phone` - [`String`](types-q-s.md#string) | | -| `pickup_location_code` - [`String`](types-q-s.md#string) | | -| `postcode` - [`String`](types-q-s.md#string) | | -| `region` - [`String`](types-q-s.md#string) | | -| `region_id` - [`Int`](types-f-i.md#int) | | -| `street` - [`String`](types-q-s.md#string) | | +| `city` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `contact_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `country_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `email` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `fax` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `latitude` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | | +| `longitude` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `phone` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `pickup_location_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `postcode` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `region` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | +| `region_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | | +| `street` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | | #### Example ```json { "city": "xyz789", - "contact_name": "xyz789", + "contact_name": "abc123", "country_id": "xyz789", "description": "xyz789", - "email": "abc123", - "fax": "abc123", - "latitude": 123.45, + "email": "xyz789", + "fax": "xyz789", + "latitude": 987.65, "longitude": 123.45, "name": "abc123", "phone": "xyz789", @@ -2663,7 +2660,7 @@ Defines Pickup Location information. "postcode": "xyz789", "region": "abc123", "region_id": 987, - "street": "abc123" + "street": "xyz789" } ``` @@ -2677,14 +2674,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | Input Field | Description | |-------------|-------------| -| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | +| `city` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2711,22 +2708,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | Input Field | Description | |-------------|-------------| -| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | -| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | +| `city` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#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`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2762,8 +2759,8 @@ Top level object returned in a pickup locations search. | Field Name | Description | |------------|-------------| | `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of products returned. | #### Example @@ -2771,7 +2768,7 @@ Top level object returned in a pickup locations search. { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2785,7 +2782,7 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2822,7 +2819,7 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | #### Example @@ -2863,12 +2860,12 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json -{"purchase_order_uid": "4"} +{"purchase_order_uid": 4} ``` @@ -2881,7 +2878,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](/reference/graphql/2-4-8/types-c-e.md#customerorder) | Placed order. | #### Example @@ -2899,7 +2896,7 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2919,7 +2916,7 @@ Contains the results of the request to place an order. |------------|-------------| | `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | | `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | -| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | +| `orderV2` - [`CustomerOrder`](/reference/graphql/2-4-8/types-c-e.md#customerorder) | Full order information. | #### Example @@ -2941,12 +2938,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -3062,9 +3059,9 @@ Can be used to retrieve the main price details in case of bundle product | Field Name | Description | |------------|-------------| -| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | +| `discount_percentage` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The regular price of the main product | #### Example @@ -3072,7 +3069,7 @@ Can be used to retrieve the main price details in case of bundle product { "discount_percentage": 123.45, "main_final_price": 987.65, - "main_price": 123.45 + "main_price": 987.65 } ``` @@ -3147,8 +3144,8 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | +| `code` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The display value of the attribute. | #### Example @@ -3169,37 +3166,37 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `activity` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Activity | -| `category_gear` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Category Gear | -| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `category_url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | -| `climate` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Climate | -| `collar` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Collar | -| `color` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Color | -| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | -| `eco_collection` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Eco Collection | -| `erin_recommends` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Erin Recommends | -| `features_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Features | -| `format` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Format | -| `gender` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Gender | -| `material` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Material | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | -| `new` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: New | -| `pattern` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Pattern | -| `performance_fabric` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Performance Fabric | -| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | -| `purpose` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Purpose | -| `sale` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sale | -| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | -| `size` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Size | -| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | -| `sleeve` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Sleeve | -| `strap_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Strap/Handle | -| `style_bags` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bags | -| `style_bottom` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style Bottom | -| `style_general` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: Style General | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | +| `activity` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Activity | +| `category_gear` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Category Gear | +| `category_id` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | +| `climate` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Climate | +| `collar` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Collar | +| `color` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Color | +| `description` - [`FilterMatchTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `eco_collection` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Eco Collection | +| `erin_recommends` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Erin Recommends | +| `features_bags` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Features | +| `format` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Format | +| `gender` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Gender | +| `material` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Material | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `new` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: New | +| `pattern` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Pattern | +| `performance_fabric` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Performance Fabric | +| `price` - [`FilterRangeTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `purpose` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Purpose | +| `sale` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Sale | +| `short_description` - [`FilterMatchTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `size` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Size | +| `sku` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `sleeve` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Sleeve | +| `strap_bags` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Strap/Handle | +| `style_bags` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Style Bags | +| `style_bottom` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Style Bottom | +| `style_general` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Attribute label: Style General | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -3249,10 +3246,10 @@ Specifies the attribute to use for sorting search results and indicates whether | Input Field | Description | |-------------|-------------| -| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | +| `name` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](/reference/graphql/2-4-8/types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -3270,8 +3267,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](/reference/graphql/2-4-8/types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3292,8 +3289,8 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | -| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The discount expressed a percentage. | #### Example @@ -3311,45 +3308,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | Input Field | Description | |-------------|-------------| -| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `category_id` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | +| `price` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -3407,18 +3404,18 @@ Contains product image information, including the image URL and label. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { "disabled": true, - "label": "abc123", - "position": 123, + "label": "xyz789", + "position": 987, "url": "abc123" } ``` @@ -3450,7 +3447,7 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | +| `sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | Product SKU. | #### Example @@ -3468,125 +3465,125 @@ Contains fields that are common to all types of products. | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `activity` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](/reference/graphql/2-4-8/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `is_returnable` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-8/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `purpose` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `review_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of all the reviews given to the product. | | `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rules` - [`[CatalogRule]`](/reference/graphql/2-4-8/types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `special_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | | `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `strap_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of a swatch image. | | `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `type_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-8/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/2-4-8/types-t-z.md#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`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`VirtualProduct`](/reference/graphql/2-4-8/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/2-4-8/types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-8/types-c-e.md#configurableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-8/types-a-b.md#bundleproduct) | +| [`DownloadableProduct`](/reference/graphql/2-4-8/types-c-e.md#downloadableproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-8/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-8/types-f-i.md#groupedproduct) | #### Example ```json { - "activity": "abc123", - "attribute_set_id": 987, + "activity": "xyz789", + "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "xyz789", + "category_gear": "abc123", "climate": "abc123", - "collar": "xyz789", + "collar": "abc123", "color": 123, "country_of_manufacture": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 987, - "features_bags": "xyz789", - "format": 987, + "eco_collection": 987, + "erin_recommends": 123, + "features_bags": "abc123", + "format": 123, "gender": "abc123", "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, - "id": 987, + "id": 123, "image": ProductImage, "is_returnable": "abc123", "manufacturer": 987, @@ -3594,24 +3591,24 @@ Contains fields that are common to all types of products. "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "xyz789", + "name": "abc123", "new": 987, - "new_from_date": "xyz789", - "new_to_date": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, "options_container": "abc123", - "pattern": "xyz789", + "pattern": "abc123", "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 987, - "quantity": 123.45, + "purpose": 123, + "quantity": 987.65, "rating_summary": 987.65, "related_products": [ProductInterface], "review_count": 987, @@ -3619,26 +3616,26 @@ Contains fields that are common to all types of products. "rules": [CatalogRule], "sale": 123, "short_description": ComplexTextValue, - "size": 987, + "size": 123, "sku": "xyz789", "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "xyz789", - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", "staged": true, "stock_status": "IN_STOCK", "strap_bags": "abc123", - "style_bags": "xyz789", + "style_bags": "abc123", "style_bottom": "abc123", "style_general": "xyz789", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 987.65, + "tier_price": 123.45, "tier_prices": [ProductTierPrices], - "type_id": "abc123", + "type_id": "xyz789", "uid": 4, - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "abc123", @@ -3658,21 +3655,21 @@ An implementation of `ProductLinksInterface`. | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { - "link_type": "xyz789", + "link_type": "abc123", "linked_product_sku": "abc123", - "linked_product_type": "xyz789", - "position": 987, - "sku": "abc123" + "linked_product_type": "abc123", + "position": 123, + "sku": "xyz789" } ``` @@ -3686,11 +3683,11 @@ Contains information about linked products, including the link type and product | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3720,15 +3717,15 @@ Contains an image in base64 format and basic information about the image. | Field Name | Description | |------------|-------------| -| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | -| `name` - [`String`](types-q-s.md#string) | The file name of the image. | -| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | +| `base64_encoded_data` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "base64_encoded_data": "xyz789", + "base64_encoded_data": "abc123", "name": "xyz789", "type": "abc123" } @@ -3744,23 +3741,23 @@ Contains a link to a video file and basic information about the video. | Field Name | Description | |------------|-------------| -| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | -| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | -| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | -| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | -| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | -| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | +| `media_type` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL to the video. | #### Example ```json { - "media_type": "abc123", - "video_description": "abc123", + "media_type": "xyz789", + "video_description": "xyz789", "video_metadata": "abc123", - "video_provider": "xyz789", - "video_title": "xyz789", - "video_url": "xyz789" + "video_provider": "abc123", + "video_title": "abc123", + "video_url": "abc123" } ``` @@ -3776,7 +3773,7 @@ Represents a product price. |------------|-------------| | `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]`](types-f-i.md#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/2-4-8/types-f-i.md#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 @@ -3824,13 +3821,13 @@ Contains details of a product review. | Field Name | Description | |------------|-------------| -| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `average_rating` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `summary` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The review text. | #### Example @@ -3838,11 +3835,11 @@ Contains details of a product review. { "average_rating": 123.45, "created_at": "abc123", - "nickname": "xyz789", + "nickname": "abc123", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], - "summary": "xyz789", - "text": "abc123" + "summary": "abc123", + "text": "xyz789" } ``` @@ -3856,15 +3853,15 @@ Contains data about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example ```json { - "name": "abc123", - "value": "abc123" + "name": "xyz789", + "value": "xyz789" } ``` @@ -3878,14 +3875,14 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { - "id": "abc123", + "id": "xyz789", "value_id": "abc123" } ``` @@ -3900,8 +3897,8 @@ Contains details about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -3909,7 +3906,7 @@ Contains details about a single aspect of a product review. ```json { "id": "abc123", - "name": "xyz789", + "name": "abc123", "values": [ProductReviewRatingValueMetadata] } ``` @@ -3924,14 +3921,14 @@ Contains details about a single value in a product review. | Field Name | Description | |------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `value` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { - "value": "xyz789", + "value": "abc123", "value_id": "abc123" } ``` @@ -3965,7 +3962,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -4005,11 +4002,11 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | Field Name | Description | |------------|-------------| -| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | +| `customer_group_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example @@ -4019,7 +4016,7 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d "percentage_value": 123.45, "qty": 123.45, "value": 987.65, - "website_id": 987.65 + "website_id": 123.45 } ``` @@ -4033,10 +4030,10 @@ Contains information about a product video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example @@ -4044,9 +4041,9 @@ Contains information about a product video. ```json { "disabled": true, - "label": "abc123", - "position": 987, - "url": "abc123", + "label": "xyz789", + "position": 123, + "url": "xyz789", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -4061,13 +4058,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](types-a-b.md#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](/reference/graphql/2-4-8/types-a-b.md#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`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](/reference/graphql/2-4-8/types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](/reference/graphql/2-4-8/types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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 @@ -4079,7 +4076,7 @@ Contains the results of a `products` query. "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } ``` @@ -4096,15 +4093,15 @@ Contains details about a purchase order. | `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!`](types-q-s.md#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](types-c-e.md#customer) | The company user who created the purchase order. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](/reference/graphql/2-4-8/types-c-e.md#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!`](types-q-s.md#string) | The purchase order number. | -| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](types-c-e.md#cart) | The quote related to the purchase order. | +| `number` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](/reference/graphql/2-4-8/types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](/reference/graphql/2-4-8/types-c-e.md#cart) | The quote related to the purchase order. | | `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -4116,12 +4113,12 @@ Contains details about a purchase order. "created_at": "xyz789", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], - "number": "abc123", + "number": "xyz789", "order": CustomerOrder, "quote": Cart, "status": "PENDING", "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -4155,7 +4152,7 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example @@ -4174,11 +4171,11 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | A formatted message. | -| `name` - [`String`](types-q-s.md#string) | The approver name. | -| `role` - [`String`](types-q-s.md#string) | The approver role. | +| `message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A formatted message. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The approver name. | +| `role` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The approver role. | | `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the event was updated. | #### Example @@ -4186,9 +4183,9 @@ Contains details about a single event in the approval flow of the purchase order { "message": "xyz789", "name": "abc123", - "role": "xyz789", + "role": "abc123", "status": "PENDING", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -4220,16 +4217,16 @@ Contains details about a purchase order approval rule. | Field Name | Description | |------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `applies_to_roles` - [`[CompanyRole]!`](/reference/graphql/2-4-8/types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](/reference/graphql/2-4-8/types-c-e.md#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!`](types-q-s.md#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The name of the purchase order approval rule. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the purchase order approval rule. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -4240,10 +4237,10 @@ Contains details about a purchase order approval rule. "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "xyz789", - "description": "abc123", + "description": "xyz789", "name": "abc123", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "abc123" } ``` @@ -4329,12 +4326,12 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | +| `quantity` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} ``` @@ -4347,21 +4344,21 @@ Defines a new purchase order approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | +| `applies_to` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#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]!`](/reference/graphql/2-4-8/types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](/reference/graphql/2-4-8/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "applies_to": ["4"], + "applies_to": [4], "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", + "description": "xyz789", "name": "abc123", "status": "ENABLED" } @@ -4377,9 +4374,9 @@ Contains metadata that can be used to render rule edit forms. | Field Name | Description | |------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | +| `available_applies_to` - [`[CompanyRole]!`](/reference/graphql/2-4-8/types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](/reference/graphql/2-4-8/types-a-b.md#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]!`](/reference/graphql/2-4-8/types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4437,8 +4434,8 @@ Contains the approval rules that the customer can see. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4446,7 +4443,7 @@ Contains the approval rules that the customer can see. { "items": [PurchaseOrderApprovalRule], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -4460,17 +4457,17 @@ Contains details about a comment. | Field Name | Description | |------------|-------------| -| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | -| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | +| `author` - [`Customer`](/reference/graphql/2-4-8/types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | A unique identifier of the comment. | #### Example ```json { "author": Customer, - "created_at": "abc123", + "created_at": "xyz789", "text": "xyz789", "uid": 4 } @@ -4506,19 +4503,19 @@ Contains details about a status change. | Field Name | Description | |------------|-------------| -| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | -| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | +| `activity` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "activity": "abc123", - "created_at": "abc123", + "activity": "xyz789", + "created_at": "xyz789", "message": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -4533,7 +4530,7 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | +| `rule_name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the applied rule. | #### Example @@ -4579,8 +4576,8 @@ Contains a list of purchase orders. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4588,7 +4585,7 @@ Contains a list of purchase orders. { "items": [PurchaseOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -4602,12 +4599,12 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of purchase order UIDs. | #### Example ```json -{"purchase_order_uids": ["4"]} +{"purchase_order_uids": [4]} ``` @@ -4642,18 +4639,18 @@ Defines the criteria to use to filter the list of purchase orders. | Input Field | Description | |-------------|-------------| -| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `company_purchase_orders` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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, + "company_purchase_orders": true, "created_date": FilterRangeTypeInput, - "require_my_approval": false, + "require_my_approval": true, "status": "PENDING" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md index 7a1a95871..c4c563ccc 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md @@ -27,16 +27,16 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `item_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | | `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `templateId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "item_id": "4", - "note": "xyz789", + "note": "abc123", "templateId": 4 } ``` @@ -72,14 +72,14 @@ Contains a notification message for a negotiable quote template. | Field Name | Description | |------------|-------------| | `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | +| `is_enabled` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | #### Example ```json { "configurations": ReCaptchaConfiguration, - "is_enabled": true + "is_enabled": false } ``` @@ -95,7 +95,7 @@ Contains reCAPTCHA form configuration details. |------------|-------------| | `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`](types-f-i.md#float) | The minimum score that identifies a user interaction as a potential risk. | +| `minimum_score` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -106,14 +106,14 @@ Contains reCAPTCHA form configuration details. ```json { - "badge_position": "xyz789", - "language_code": "abc123", - "minimum_score": 123.45, + "badge_position": "abc123", + "language_code": "xyz789", + "minimum_score": 987.65, "re_captcha_type": "INVISIBLE", "technical_failure_message": "xyz789", - "theme": "abc123", - "validation_failure_message": "abc123", - "website_key": "xyz789" + "theme": "xyz789", + "validation_failure_message": "xyz789", + "website_key": "abc123" } ``` @@ -130,9 +130,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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!`](types-a-b.md#boolean) | Return whether recaptcha is enabled or not | +| `is_enabled` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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!`](types-f-i.md#float) | The minimum score that identifies a user interaction as a potential risk. | +| `minimum_score` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -144,9 +144,9 @@ Contains reCAPTCHA V3-Invisible configuration details. "failure_message": "xyz789", "forms": ["PLACE_ORDER"], "is_enabled": false, - "language_code": "abc123", + "language_code": "xyz789", "minimum_score": 987.65, - "theme": "abc123", + "theme": "xyz789", "website_key": "xyz789" } ``` @@ -204,7 +204,7 @@ Contains reCAPTCHA V3-Invisible configuration details. | Field Name | Description | |------------|-------------| | `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example @@ -213,7 +213,7 @@ Contains reCAPTCHA V3-Invisible configuration details. { "code": "abc123", "id": 987, - "name": "abc123" + "name": "xyz789" } ``` @@ -232,7 +232,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -245,7 +245,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -293,7 +293,7 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { "cart_id": "abc123", - "gift_card_code": "abc123" + "gift_card_code": "xyz789" } ``` @@ -307,7 +307,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -325,7 +325,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -343,12 +343,12 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -361,7 +361,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -380,15 +380,15 @@ Specifies which items to remove from the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { - "cart_id": "abc123", - "cart_item_id": 123, + "cart_id": "xyz789", + "cart_item_id": 987, "cart_item_uid": "4" } ``` @@ -403,7 +403,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -421,16 +421,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_item_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "quote_item_uids": ["4"], - "quote_uid": "4" -} +{"quote_item_uids": ["4"], "quote_uid": 4} ``` @@ -443,7 +440,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -461,13 +458,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `item_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"item_uids": [4], "template_id": 4} +{"item_uids": [4], "template_id": "4"} ``` @@ -480,16 +477,13 @@ Defines which products to remove from a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{ - "products": ["4"], - "uid": "4" -} +{"products": ["4"], "uid": 4} ``` @@ -502,8 +496,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/2-4-8/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/2-4-8/types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -524,12 +518,12 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example ```json -{"return_shipping_tracking_uid": 4} +{"return_shipping_tracking_uid": "4"} ``` @@ -560,7 +554,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -583,7 +577,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -596,7 +590,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -616,15 +610,15 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example ```json { "quote_comment": "abc123", - "quote_name": "abc123", - "quote_uid": "4" + "quote_name": "xyz789", + "quote_uid": 4 } ``` @@ -638,7 +632,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -656,8 +650,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](/reference/graphql/2-4-8/types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -688,7 +682,7 @@ Contains information needed to start a return request. ```json { "comment_text": "abc123", - "contact_email": "abc123", + "contact_email": "xyz789", "items": [RequestReturnItemInput], "token": "abc123" } @@ -704,9 +698,9 @@ Defines properties of a negotiable quote request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](types-a-b.md#boolean) | Flag indicating if quote is draft or not. | +| `cart_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Flag indicating if quote is draft or not. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -716,7 +710,7 @@ Defines properties of a negotiable quote request. "cart_id": "4", "comment": NegotiableQuoteCommentInput, "is_draft": false, - "quote_name": "abc123" + "quote_name": "xyz789" } ``` @@ -730,7 +724,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -748,7 +742,7 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example @@ -769,7 +763,7 @@ Contains information needed to start a return request. | `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!`](types-f-i.md#id) | The unique ID for a `Order` object. | +| `order_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Order` object. | #### Example @@ -792,9 +786,9 @@ Contains details about an item to be returned. | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](types-f-i.md#float) | The quantity of the item to be returned. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](/reference/graphql/2-4-8/types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#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 @@ -846,20 +840,20 @@ Defines the contents of a requisition list. |------------|-------------| | `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!`](types-f-i.md#int) | The number of items in the list. | +| `items_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example ```json { - "description": "abc123", + "description": "xyz789", "items": RequistionListItems, - "items_count": 123, - "name": "xyz789", - "uid": "4", + "items_count": 987, + "name": "abc123", + "uid": 4, "updated_at": "abc123" } ``` @@ -874,8 +868,8 @@ Defines requisition list filters. | Input Field | Description | |-------------|-------------| -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](/reference/graphql/2-4-8/types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -897,20 +891,20 @@ The interface for requisition list items. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for the requisition list item. | #### Possible Types | RequisitionListItemInterface Types | |----------------| | [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | +| [`VirtualRequisitionListItem`](/reference/graphql/2-4-8/types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](/reference/graphql/2-4-8/types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](/reference/graphql/2-4-8/types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](/reference/graphql/2-4-8/types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](/reference/graphql/2-4-8/types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -918,7 +912,7 @@ The interface for requisition list items. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -933,9 +927,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-8/types-c-e.md#enteredoptioninput) | Entered option IDs. | | `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -945,8 +939,8 @@ Defines the items to add. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["abc123"], + "quantity": 987.65, + "selected_options": ["xyz789"], "sku": "abc123" } ``` @@ -963,7 +957,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -987,7 +981,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | +| `total_pages` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of pages returned. | #### Example @@ -995,7 +989,7 @@ Contains an array of items added to a requisition list. { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 123 + "total_pages": 987 } ``` @@ -1015,10 +1009,10 @@ Contains details about a return. | `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`](types-c-e.md#customerorder) | The order associated with the return. | +| `order` - [`CustomerOrder`](/reference/graphql/2-4-8/types-c-e.md#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!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -1050,15 +1044,15 @@ Contains details about a return comment. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example ```json { - "author_name": "xyz789", + "author_name": "abc123", "created_at": "xyz789", - "text": "abc123", + "text": "xyz789", "uid": 4 } ``` @@ -1074,16 +1068,16 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "uid": "4", - "value": "abc123" + "value": "xyz789" } ``` @@ -1105,9 +1099,9 @@ The customer information for the return. ```json { - "email": "xyz789", + "email": "abc123", "firstname": "abc123", - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -1122,12 +1116,12 @@ Contains details about a product being returned. | 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]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item requested to be returned. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](/reference/graphql/2-4-8/types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of the item requested to be returned. | | `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1136,7 +1130,7 @@ Contains details about a product being returned. "custom_attributes": [ReturnCustomAttribute], "custom_attributesV2": [AttributeValueInterface], "order_item": OrderItemInterface, - "quantity": 987.65, + "quantity": 123.45, "request_quantity": 123.45, "status": "PENDING", "uid": 4 @@ -1153,34 +1147,34 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/2-4-8/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | | `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/2-4-8/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/2-4-8/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether the attribute value must be unique. | | `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `multiline_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/2-4-8/types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/2-4-8/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": 4, - "default_value": "abc123", + "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, + "is_required": true, + "is_unique": false, + "label": "abc123", + "multiline_count": 987, "options": [CustomAttributeOptionInterface], "sort_order": 987, "validate_rules": [ValidationRule] @@ -1242,7 +1236,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `city` - [`String!`](#string) | The city for product returns. | | `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](types-c-e.md#country) | An object that defines the country for product returns. | +| `country` - [`Country!`](/reference/graphql/2-4-8/types-c-e.md#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. | @@ -1258,7 +1252,7 @@ Contains details about the shipping address used for receiving returned items. "postcode": "abc123", "region": Region, "street": ["xyz789"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -1273,15 +1267,12 @@ Contains details about the carrier on a return. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example ```json -{ - "label": "xyz789", - "uid": "4" -} +{"label": "xyz789", "uid": 4} ``` @@ -1297,7 +1288,7 @@ Contains shipping and tracking details. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1306,7 +1297,7 @@ Contains shipping and tracking details. "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, "tracking_number": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1386,7 +1377,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | +| `total_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The total number of return requests. | #### Example @@ -1408,12 +1399,12 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example ```json -{"result": true} +{"result": false} ``` @@ -1450,13 +1441,13 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | -| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | +| `money` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The reward points amount in points. | #### Example ```json -{"money": Money, "points": 987.65} +{"money": Money, "points": 123.45} ``` @@ -1472,16 +1463,16 @@ Contain details about the reward points transaction. | `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!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | +| `points_change` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example ```json { "balance": RewardPointsAmount, - "change_reason": "xyz789", + "change_reason": "abc123", "date": "abc123", - "points_change": 987.65 + "points_change": 123.45 } ``` @@ -1517,13 +1508,13 @@ Contains details about customer's reward points rate. | Field Name | Description | |------------|-------------| -| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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. | +| `currency_amount` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#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!`](/reference/graphql/2-4-8/types-f-i.md#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} +{"currency_amount": 987.65, "points": 987.65} ``` @@ -1575,31 +1566,31 @@ Routable entities serve as the model for a rendered page. | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](types-c-e.md#cmspage) | -| [`CategoryTree`](types-c-e.md#categorytree) | -| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`CmsPage`](/reference/graphql/2-4-8/types-c-e.md#cmspage) | +| [`CategoryTree`](/reference/graphql/2-4-8/types-c-e.md#categorytree) | +| [`VirtualProduct`](/reference/graphql/2-4-8/types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](/reference/graphql/2-4-8/types-c-e.md#configurableproduct) | +| [`BundleProduct`](/reference/graphql/2-4-8/types-a-b.md#bundleproduct) | +| [`DownloadableProduct`](/reference/graphql/2-4-8/types-c-e.md#downloadableproduct) | +| [`GiftCardProduct`](/reference/graphql/2-4-8/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/2-4-8/types-f-i.md#groupedproduct) | | [`RoutableUrl`](#routableurl) | #### Example ```json { - "redirect_code": 123, - "relative_url": "xyz789", + "redirect_code": 987, + "relative_url": "abc123", "type": "CMS_PAGE" } ``` @@ -1614,16 +1605,16 @@ Default implementation of RoutableInterface. This type is returned when the URL | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "redirect_code": 123, - "relative_url": "abc123", + "redirect_code": 987, + "relative_url": "xyz789", "type": "CMS_PAGE" } ``` @@ -1645,8 +1636,8 @@ Defines the name and value of a SDK parameter ```json { - "name": "xyz789", - "value": "abc123" + "name": "abc123", + "value": "xyz789" } ``` @@ -1668,7 +1659,7 @@ Contains details about a comment. ```json { "message": "xyz789", - "timestamp": "xyz789" + "timestamp": "abc123" } ``` @@ -1702,14 +1693,14 @@ Provides navigation for the query response. | Field Name | Description | |------------|-------------| -| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | -| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | +| `current_page` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 123, "page_size": 123, "total_pages": 987} +{"current_page": 987, "page_size": 123, "total_pages": 987} ``` @@ -1727,7 +1718,7 @@ A string that contains search suggestion #### Example ```json -{"search": "abc123"} +{"search": "xyz789"} ``` @@ -1740,10 +1731,10 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example @@ -1753,7 +1744,7 @@ Contains details about a selected bundle option. "id": 987, "label": "abc123", "type": "abc123", - "uid": "4", + "uid": 4, "values": [SelectedBundleOptionValue] } ``` @@ -1768,25 +1759,25 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | Use `uid` instead | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Use `uid` instead | | `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `original_price` - [`Money!`](types-k-p.md#money) | The original price of the value for the selected bundle product option. | -| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | -| `priceV2` - [`Money!`](types-k-p.md#money) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `original_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The original price of the value for the selected bundle product option. | +| `price` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | +| `priceV2` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { - "id": 987, - "label": "abc123", + "id": 123, + "label": "xyz789", "original_price": Money, - "price": 123.45, + "price": 987.65, "priceV2": Money, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 } ``` @@ -1800,11 +1791,11 @@ Contains details about a selected configurable option. | Field Name | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `configurable_product_option_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | | `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | | `value_label` - [`String!`](#string) | The display name of the selected configurable option. | #### Example @@ -1812,9 +1803,9 @@ Contains details about a selected configurable option. ```json { "configurable_product_option_uid": 4, - "configurable_product_option_value_uid": 4, - "id": 123, - "option_label": "abc123", + "configurable_product_option_value_uid": "4", + "id": 987, + "option_label": "xyz789", "value_id": 123, "value_label": "abc123" } @@ -1837,7 +1828,7 @@ Contains details about an attribute the buyer selected. ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "xyz789" } ``` @@ -1852,11 +1843,11 @@ Identifies a customized product that has been placed in a cart. | Field Name | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customizable option is required. | +| `customizable_option_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the customizable option is required. | | `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](types-f-i.md#int) | A value indicating the order to display this option. | +| `sort_order` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -1864,10 +1855,10 @@ Identifies a customized product that has been placed in a cart. ```json { - "customizable_option_uid": "4", - "id": 987, - "is_required": false, - "label": "xyz789", + "customizable_option_uid": 4, + "id": 123, + "is_required": true, + "label": "abc123", "sort_order": 123, "type": "xyz789", "values": [SelectedCustomizableOptionValue] @@ -1884,10 +1875,10 @@ Identifies the value of the selected customized option. | Field Name | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `customizable_option_value_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | | `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](/reference/graphql/2-4-8/types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | | `value` - [`String!`](#string) | The text identifying the selected value. | #### Example @@ -1898,7 +1889,7 @@ Identifies the value of the selected customized option. "id": 123, "label": "xyz789", "price": CartItemSelectedOptionValuePrice, - "value": "abc123" + "value": "xyz789" } ``` @@ -1936,14 +1927,14 @@ Contains details about the selected shipping method and carrier. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#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!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `price_excl_tax` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1952,9 +1943,9 @@ Contains details about the selected shipping method and carrier. "amount": Money, "base_amount": Money, "carrier_code": "xyz789", - "carrier_title": "xyz789", + "carrier_title": "abc123", "method_code": "abc123", - "method_title": "abc123", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1970,7 +1961,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](types-f-i.md#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -2024,7 +2015,7 @@ An output object that contains information about the recipient. ```json { "email": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -2045,7 +2036,7 @@ Contains details about a recipient. ```json { - "email": "abc123", + "email": "xyz789", "name": "xyz789" } ``` @@ -2068,9 +2059,9 @@ An output object that contains information about the sender. ```json { - "email": "abc123", - "message": "abc123", - "name": "abc123" + "email": "xyz789", + "message": "xyz789", + "name": "xyz789" } ``` @@ -2093,8 +2084,8 @@ Contains details about the sender. ```json { "email": "abc123", - "message": "abc123", - "name": "abc123" + "message": "xyz789", + "name": "xyz789" } ``` @@ -2108,13 +2099,13 @@ Contains details about the configuration of the Email to a Friend feature. | Field Name | Description | |------------|-------------| -| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | +| `enabled_for_customers` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": true, "enabled_for_guests": true} +{"enabled_for_customers": false, "enabled_for_guests": false} ``` @@ -2127,8 +2118,8 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2149,7 +2140,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2167,7 +2158,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](/reference/graphql/2-4-8/types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2189,7 +2180,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2208,19 +2199,19 @@ Defines the gift options applied to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/2-4-8/types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_message": GiftMessageInput, - "gift_receipt_included": true, - "gift_wrapping_id": "4", + "gift_receipt_included": false, + "gift_wrapping_id": 4, "printed_card_included": false } ``` @@ -2235,7 +2226,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The modified cart object. | #### Example @@ -2260,7 +2251,7 @@ Defines the guest email and cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "email": "abc123" } ``` @@ -2275,7 +2266,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2293,7 +2284,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2311,15 +2302,15 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2333,7 +2324,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2351,15 +2342,15 @@ Defines the payment method of the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2373,7 +2364,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2391,16 +2382,16 @@ Defines the shipping address to assign to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| `customer_address_id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](/reference/graphql/2-4-8/types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "customer_address_id": "4", - "quote_uid": "4", + "customer_address_id": 4, + "quote_uid": 4, "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2417,7 +2408,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2435,14 +2426,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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", + "quote_uid": 4, "shipping_methods": [ShippingMethodInput] } ``` @@ -2457,7 +2448,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2475,15 +2466,15 @@ Defines the shipping address to assign to the negotiable quote template. | Input Field | Description | |-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": "4" + "template_id": 4 } ``` @@ -2498,13 +2489,13 @@ Applies a payment method to the quote. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/2-4-8/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "payment_method": PaymentMethodInput } ``` @@ -2520,7 +2511,7 @@ Applies a payment method to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/2-4-8/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2541,7 +2532,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2566,7 +2557,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2581,7 +2572,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2606,7 +2597,7 @@ Applies one or shipping methods to the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "shipping_methods": [ShippingMethodInput] } ``` @@ -2621,7 +2612,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2661,12 +2652,12 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example ```json -{"is_shared": false} +{"is_shared": true} ``` @@ -2686,7 +2677,7 @@ Defines the sender of an invitation to view a gift registry. ```json { - "message": "xyz789", + "message": "abc123", "name": "xyz789" } ``` @@ -2718,12 +2709,12 @@ Defines whether bundle items must be shipped together. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | #### Example @@ -2748,19 +2739,19 @@ Order shipment item details. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/2-4-8/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | -| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | +| [`BundleShipmentItem`](/reference/graphql/2-4-8/types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](/reference/graphql/2-4-8/types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example @@ -2769,9 +2760,9 @@ Order shipment item details. { "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_shipped": 123.45 } ``` @@ -2810,8 +2801,8 @@ Defines a single shipping address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `address` - [`CartAddressInput`](/reference/graphql/2-4-8/types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -2820,7 +2811,7 @@ Defines a single shipping address. ```json { "address": CartAddressInput, - "customer_address_id": 123, + "customer_address_id": 987, "customer_notes": "abc123", "pickup_location_code": "abc123" } @@ -2836,25 +2827,25 @@ Contains shipping addresses and methods. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | An array that lists the items in the cart. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/2-4-8/types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](/reference/graphql/2-4-8/types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](/reference/graphql/2-4-8/types-c-e.md#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!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/2-4-8/types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#int) | Id of the customer address. | -| `items_weight` - [`Float`](types-f-i.md#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Id of the customer address. | +| `items_weight` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `same_as_billing` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shipping address is same as billing address. | +| `region` - [`CartAddressRegion`](/reference/graphql/2-4-8/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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. | @@ -2881,16 +2872,16 @@ Contains shipping addresses and methods. "lastname": "xyz789", "middlename": "xyz789", "pickup_location_code": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": CartAddressRegion, - "same_as_billing": true, + "same_as_billing": false, "selected_shipping_method": SelectedShippingMethod, "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "xyz789", - "vat_id": "xyz789" + "suffix": "abc123", + "telephone": "xyz789", + "uid": "abc123", + "vat_id": "abc123" } ``` @@ -2904,7 +2895,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of the discount. | #### Example @@ -2922,11 +2913,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](types-k-p.md#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The shipping amount, including tax. | | `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | +| `taxes` - [`[TaxItem]`](/reference/graphql/2-4-8/types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The total amount for shipping. | #### Example @@ -2957,8 +2948,8 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "abc123", - "method_code": "xyz789" + "carrier_code": "xyz789", + "method_code": "abc123" } ``` @@ -2972,23 +2963,23 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/2-4-8/types-f-i.md#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]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-8/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/2-4-8/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/2-4-8/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | | `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-8/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -3000,17 +2991,17 @@ An implementation for simple product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", + "id": "xyz789", "is_available": false, - "max_qty": 987.65, - "min_qty": 123.45, + "max_qty": 123.45, + "min_qty": 987.65, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -3025,178 +3016,178 @@ Defines a simple product, which is tangible and is usually sold in single units | Field Name | Description | |------------|-------------| | `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `categories` - [`[CategoryInterface]`](/reference/graphql/2-4-8/types-c-e.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-8/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#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`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `manufacturer` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-8/types-k-p.md#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`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `min_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | | `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-8/types-c-e.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-8/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/2-4-8/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-8/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#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!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `review_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](/reference/graphql/2-4-8/types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#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`](types-f-i.md#float) | The discounted price of the product. | +| `special_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The discounted price of the product. | | `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-8/types-k-p.md#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`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/2-4-8/types-t-z.md#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!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#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]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/2-4-8/types-t-z.md#urlrewrite) | URL rewrites list | | `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/2-4-8/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { "activity": "xyz789", - "attribute_set_id": 987, - "canonical_url": "xyz789", + "attribute_set_id": 123, + "canonical_url": "abc123", "categories": [CategoryInterface], - "category_gear": "xyz789", - "climate": "abc123", + "category_gear": "abc123", + "climate": "xyz789", "collar": "xyz789", - "color": 123, - "country_of_manufacture": "xyz789", - "created_at": "abc123", + "color": 987, + "country_of_manufacture": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "eco_collection": 987, + "eco_collection": 123, "erin_recommends": 123, "features_bags": "xyz789", "format": 123, "gender": "abc123", "gift_message_available": false, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "id": 987, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 123, - "material": "xyz789", - "max_sale_qty": 987.65, + "manufacturer": 987, + "material": "abc123", + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", "min_sale_qty": 123.45, - "name": "xyz789", + "name": "abc123", "new": 987, "new_from_date": "xyz789", "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "pattern": "xyz789", - "performance_fabric": 123, + "performance_fabric": 987, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "purpose": 123, - "quantity": 123.45, - "rating_summary": 123.45, + "purpose": 987, + "quantity": 987.65, + "rating_summary": 987.65, "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "xyz789", - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, - "size": 123, + "size": 987, "sku": "abc123", "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "xyz789", + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "abc123", "staged": true, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", - "style_bags": "abc123", + "strap_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "abc123", - "style_general": "xyz789", - "swatch_image": "xyz789", + "style_general": "abc123", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", - "uid": 4, - "updated_at": "xyz789", + "uid": "4", + "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "xyz789", + "url_key": "abc123", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website], "weight": 987.65 } @@ -3212,8 +3203,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-8/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-8/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -3235,9 +3226,9 @@ Contains details about simple products added to a requisition list. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3263,9 +3254,9 @@ Contains a simple 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!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -3274,7 +3265,7 @@ Contains a simple product wish list item. "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": 4, + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -3298,8 +3289,8 @@ Smart button payment inputs ```json { - "payment_source": "abc123", - "payments_order_id": "abc123", + "payment_source": "xyz789", + "payments_order_id": "xyz789", "paypal_order_id": "abc123" } ``` @@ -3312,12 +3303,12 @@ Smart button payment inputs | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](types-a-b.md#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `button_styles` - [`ButtonStyles`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](types-k-p.md#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `display_message` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](/reference/graphql/2-4-8/types-k-p.md#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 | @@ -3328,15 +3319,15 @@ Smart button payment inputs ```json { "button_styles": ButtonStyles, - "code": "abc123", - "display_message": false, + "code": "xyz789", + "display_message": true, "display_venmo": true, - "is_visible": false, + "is_visible": true, "message_styles": MessageStyles, - "payment_intent": "xyz789", + "payment_intent": "abc123", "sdk_params": [SDKParams], "sort_order": "xyz789", - "title": "xyz789" + "title": "abc123" } ``` @@ -3376,7 +3367,7 @@ Defines a possible sort field. ```json { - "label": "xyz789", + "label": "abc123", "value": "xyz789" } ``` @@ -3471,27 +3462,27 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `autocomplete_on_storefront` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | -| `braintree_3dsecure_always_request_3ds` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure, always request 3D Secure flag. | +| `braintree_3dsecure_allowspecific` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | -| `braintree_ach_direct_debit_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree ACH vault status. | +| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Braintree ACH vault status. | | `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | -| `braintree_applepay_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree Apple Pay vault status. | +| `braintree_applepay_vault_active` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Braintree Apple Pay vault status. | | `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | -| `braintree_cc_vault_cvv` - [`Boolean`](types-a-b.md#boolean) | Braintree cc vault CVV re-verification enabled status. | +| `braintree_cc_vault_cvv` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree Google Pay vault status. | +| `braintree_googlepay_vault_active` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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. | @@ -3499,130 +3490,130 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | +| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal mini-cart & cart button show. | +| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Credit checkout button show status. | +| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging checkout show status. | +| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later checkout button show status. | +| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal checkout button show. | +| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Credit PDP button show status. | +| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging PDP show status. | +| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later PDP button show status. | +| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal PDP button show. | +| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Should display Braintree PayPal in mini-cart & cart? | +| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | -| `braintree_paypal_send_cart_line_items` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | -| `braintree_paypal_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree PayPal vault status. | -| `cart_expires_in_days` - [`Int`](types-f-i.md#int) | checkout/cart/delete_quote_after: quote lifetime in days. | +| `braintree_paypal_require_billing_address` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#int) | checkout/cart_link/use_qty: what to show in the display cart summary, number of items or item quantities. | +| `cart_summary_display_quantity` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-8/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#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_sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-k-p.md#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | +| `configurable_product_image` - [`ProductImageThumbnail!`](/reference/graphql/2-4-8/types-k-p.md#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!`](types-a-b.md#boolean) | Indicates whether the Contact Us form in enabled. | +| `contact_enabled` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](types-f-i.md#float) | Customer access token lifetime. | +| `create_account_confirmation` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#int) | Configuration data from tax/display/type | -| `display_shipping_prices` - [`Int!`](types-f-i.md#int) | Configuration data from tax/display/shipping | -| `display_state_if_optional` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - general/region/display_all | +| `demonotice` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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!`](types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | -| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_email | -| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_list | -| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_sales | -| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display | -| `fixed_product_taxes_enable` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/enable | -| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/include_in_subtotal | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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!`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_all_customer_groups | -| `graphql_share_customer_group` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | -| `grid_per_page` - [`Int`](types-f-i.md#int) | The default number of products per page in Grid View. | +| `graphql_share_all_customer_groups` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_all_customer_groups | +| `graphql_share_customer_group` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-k-p.md#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | +| `grouped_product_image` - [`ProductImageThumbnail!`](/reference/graphql/2-4-8/types-k-p.md#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`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_checkout_agreements_enabled` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | -| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | -| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_checkout_agreements_enabled` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#int) | The default number of products per page in List View. | +| `list_per_page` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](types-f-i.md#int) | The width of the logo image, in pixels. | +| `logo_height` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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. | @@ -3637,34 +3628,34 @@ Contains information about a store's configuration. | `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`](types-f-i.md#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | +| `max_items_in_order_summary` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | -| `minicart_max_items` - [`Int`](types-f-i.md#int) | checkout/sidebar/count: maximum number of items to show in minicart. | +| `minicart_display` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether newsletters are enabled. | +| `newsletter_enabled` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | -| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | -| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | -| `orders_invoices_credit_memos_display_price` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/price | -| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/shipping | -| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | -| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/zero_tax | +| `order_cancellation_enabled` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](/reference/graphql/2-4-8/types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-k-p.md#money) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages. | +| `printed_card_priceV2` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-8/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether quick order functionality is enabled. | +| `quickorder_active` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `root_category_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/2-4-8/types-f-i.md#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`. | @@ -3672,39 +3663,39 @@ Contains information about a store's configuration. | `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!`](types-a-b.md#boolean) | Configuration data from catalog/rule/share_all_catalog_rules | -| `share_all_sales_rule` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from promo/graphql/share_all_sales_rule | -| `share_applied_catalog_rules` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from catalog/rule/share_applied_catalog_rules | -| `share_applied_sales_rule` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from promo/graphql/share_applied_sales_rule | -| `shopping_cart_display_full_summary` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `show_cms_breadcrumbs` - [`Int`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `share_all_catalog_rules` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from catalog/rule/share_all_catalog_rules | +| `share_all_sales_rule` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from promo/graphql/share_all_sales_rule | +| `share_applied_catalog_rules` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from catalog/rule/share_applied_catalog_rules | +| `share_applied_sales_rule` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Configuration data from promo/graphql/share_applied_sales_rule | +| `shopping_cart_display_full_summary` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](/reference/graphql/2-4-8/types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-f-i.md#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`](types-f-i.md#int) | The store view sort order. | +| `store_sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | -| `website_id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `use_store_in_url` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_enable_for_specific_countries` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#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`](types-f-i.md#int) | A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout. | +| `zero_subtotal_sort_order` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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 @@ -3712,206 +3703,206 @@ Contains information about a store's configuration. ```json { "absolute_footer": "xyz789", - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "abc123", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "xyz789", "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "xyz789", + "allow_items": "abc123", "allow_order": "abc123", - "allow_printed_card": "xyz789", + "allow_printed_card": "abc123", "autocomplete_on_storefront": true, "base_currency_code": "abc123", "base_link_url": "abc123", - "base_media_url": "abc123", - "base_static_url": "xyz789", + "base_media_url": "xyz789", + "base_static_url": "abc123", "base_url": "abc123", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": true, - "braintree_3dsecure_specificcountry": "abc123", + "braintree_3dsecure_specificcountry": "xyz789", "braintree_3dsecure_threshold_amount": "xyz789", - "braintree_3dsecure_verify_3dsecure": 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": "xyz789", "braintree_cc_vault_cvv": false, - "braintree_environment": "xyz789", + "braintree_environment": "abc123", "braintree_googlepay_btn_color": "abc123", - "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_cctypes": "xyz789", "braintree_googlepay_merchant_id": "abc123", "braintree_googlepay_vault_active": true, "braintree_local_payment_allowed_methods": "abc123", "braintree_local_payment_fallback_button_text": "abc123", - "braintree_local_payment_redirect_on_fail": "abc123", - "braintree_merchant_account_id": "abc123", + "braintree_local_payment_redirect_on_fail": "xyz789", + "braintree_merchant_account_id": "xyz789", "braintree_paypal_button_location_cart_type_credit_color": "abc123", - "braintree_paypal_button_location_cart_type_credit_label": "xyz789", + "braintree_paypal_button_location_cart_type_credit_label": "abc123", "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": "abc123", - "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_show": false, - "braintree_paypal_button_location_cart_type_messaging_text_color": "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": "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_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": "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_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": "xyz789", - "braintree_paypal_button_location_checkout_type_credit_shape": "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_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_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_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_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": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", - "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "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": "abc123", - "braintree_paypal_button_location_productpage_type_credit_show": false, + "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": "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_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_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_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_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": false, + "braintree_paypal_require_billing_address": true, "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": true, + "braintree_paypal_vault_active": false, "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", - "cart_printed_card": "abc123", - "cart_summary_display_quantity": 987, + "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": false, - "check_money_order_enabled": false, + "check_money_order_enabled": true, "check_money_order_make_check_payable_to": "xyz789", - "check_money_order_max_order_total": "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_max_order_total": "abc123", + "check_money_order_min_order_total": "abc123", + "check_money_order_new_order_status": "abc123", + "check_money_order_payment_from_specific_countries": "xyz789", "check_money_order_send_check_to": "abc123", "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", + "check_money_order_title": "xyz789", "cms_home_page": "abc123", "cms_no_cookies": "abc123", "cms_no_route": "abc123", - "code": "xyz789", + "code": "abc123", "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "abc123", "contact_enabled": false, "copyright": "xyz789", - "countries_with_required_region": "xyz789", + "countries_with_required_region": "abc123", "create_account_confirmation": true, - "customer_access_token_lifetime": 123.45, + "customer_access_token_lifetime": 987.65, "default_country": "abc123", - "default_description": "xyz789", + "default_description": "abc123", "default_display_currency_code": "abc123", "default_keywords": "xyz789", - "default_title": "xyz789", + "default_title": "abc123", "demonotice": 123, - "display_product_prices_in_catalog": 123, - "display_shipping_prices": 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": true, + "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": false, - "fixed_product_taxes_include_fpt_in_subtotal": true, - "front": "abc123", - "graphql_share_all_customer_groups": false, - "graphql_share_customer_group": true, + "fixed_product_taxes_display_prices_in_sales_modules": 123, + "fixed_product_taxes_display_prices_on_product_view_page": 987, + "fixed_product_taxes_enable": true, + "fixed_product_taxes_include_fpt_in_subtotal": false, + "front": "xyz789", + "graphql_share_all_customer_groups": true, + "graphql_share_customer_group": false, "grid_per_page": 123, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", "head_includes": "abc123", - "head_shortcut_icon": "xyz789", - "header_logo_src": "xyz789", + "head_shortcut_icon": "abc123", + "header_logo_src": "abc123", "id": 123, "is_checkout_agreements_enabled": false, - "is_default_store": false, - "is_default_store_group": 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": true, "is_requisition_list_active": "xyz789", - "list_mode": "xyz789", - "list_per_page": 987, + "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": "xyz789", - "magento_reward_general_min_points_balance": "abc123", + "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_min_points_balance": "xyz789", "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "xyz789", - "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_customer": "abc123", + "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "abc123", + "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, + "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_display": true, "minicart_max_items": 987, "minimum_password_length": "xyz789", "newsletter_enabled": true, - "no_route": "abc123", - "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "no_route": "xyz789", + "optional_zip_countries": "xyz789", + "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_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_zero_tax": false, + "orders_invoices_credit_memos_display_zero_tax": true, "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "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_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", + "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", @@ -3921,39 +3912,39 @@ Contains information about a store's configuration. "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "share_all_catalog_rules": false, - "share_all_sales_rule": false, + "share_all_sales_rule": true, "share_applied_catalog_rules": true, "share_applied_sales_rule": false, - "shopping_cart_display_full_summary": true, + "shopping_cart_display_full_summary": false, "shopping_cart_display_grand_total": true, "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 987, + "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": true, - "show_cms_breadcrumbs": 123, - "store_code": 4, + "shopping_cart_display_zero_tax": false, + "show_cms_breadcrumbs": 987, + "store_code": "4", "store_group_code": "4", "store_group_name": "xyz789", "store_name": "xyz789", - "store_sort_order": 987, + "store_sort_order": 123, "timezone": "xyz789", "title_prefix": "xyz789", - "title_separator": "abc123", - "title_suffix": "abc123", + "title_separator": "xyz789", + "title_suffix": "xyz789", "use_store_in_url": false, - "website_code": 4, + "website_code": "4", "website_id": 987, - "website_name": "abc123", - "weight_unit": "abc123", - "welcome": "xyz789", - "zero_subtotal_enable_for_specific_countries": true, + "website_name": "xyz789", + "weight_unit": "xyz789", + "welcome": "abc123", + "zero_subtotal_enable_for_specific_countries": false, "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": 123, - "zero_subtotal_title": "abc123" + "zero_subtotal_title": "xyz789" } ``` @@ -3967,19 +3958,19 @@ Indicates where an attribute can be displayed. | Field Name | Description | |------------|-------------| -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | +| `position` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](/reference/graphql/2-4-8/types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example ```json { - "position": 987, + "position": 123, "use_in_layered_navigation": "NO", - "use_in_product_listing": true, + "use_in_product_listing": false, "use_in_search_results_layered_navigation": true, "visible_on_catalog_pages": false } @@ -4010,11 +4001,11 @@ Specifies the quote template properties to update. | Input Field | Description | |-------------|-------------| | `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for minimum orders | +| `max_order_commitment` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Commitment for minimum orders | | `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -4023,7 +4014,7 @@ Specifies the quote template properties to update. "comment": "xyz789", "max_order_commitment": 123, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], @@ -4088,7 +4079,7 @@ Describes the swatch type and a value. ```json { "type": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -4106,9 +4097,9 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | -| [`TextSwatchData`](types-t-z.md#textswatchdata) | -| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | +| [`ImageSwatchData`](/reference/graphql/2-4-8/types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](/reference/graphql/2-4-8/types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](/reference/graphql/2-4-8/types-c-e.md#colorswatchdata) | #### Example @@ -4159,7 +4150,7 @@ Swatch attribute metadata input types. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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.)* | @@ -4171,7 +4162,7 @@ Swatch attribute metadata input types. "items_count": 987, "label": "xyz789", "swatch_data": SwatchData, - "value_string": "xyz789" + "value_string": "abc123" } ``` 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 index 4e5c90c6c..350417a82 100644 --- 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 @@ -8,9 +8,9 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | -| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | +| `amount` - [`Money!`](/reference/graphql/2-4-8/types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A title that describes the tax. | #### Example @@ -18,7 +18,7 @@ Contains tax item details. { "amount": Money, "rate": 987.65, - "title": "xyz789" + "title": "abc123" } ``` @@ -48,12 +48,12 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -86,9 +86,9 @@ Defines a price based on the quantity purchased. | Field Name | Description | |------------|-------------| -| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | -| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | +| `discount` - [`ProductDiscount`](/reference/graphql/2-4-8/types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -110,14 +110,14 @@ Modifies the specified items in the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | +| `cart_id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](/reference/graphql/2-4-8/types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [CartItemUpdateInput] } ``` @@ -132,8 +132,8 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/2-4-8/types-c-e.md#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](/reference/graphql/2-4-8/types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | #### Example @@ -154,7 +154,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/2-4-8/types-c-e.md#company) | The updated company instance. | #### Example @@ -172,7 +172,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](/reference/graphql/2-4-8/types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -190,7 +190,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/2-4-8/types-c-e.md#company) | The updated company instance. | #### Example @@ -208,7 +208,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](/reference/graphql/2-4-8/types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -226,7 +226,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | +| `user` - [`Customer!`](/reference/graphql/2-4-8/types-c-e.md#customer) | The updated company user instance. | #### Example @@ -244,12 +244,12 @@ Defines updates to a `GiftRegistry` object. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | -| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-8/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](/reference/graphql/2-4-8/types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/2-4-8/types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](/reference/graphql/2-4-8/types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -258,7 +258,7 @@ Defines updates to a `GiftRegistry` object. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "xyz789", + "event_name": "abc123", "message": "abc123", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, @@ -276,17 +276,17 @@ Defines updates to an item in a gift registry. | Input Field | Description | |-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | +| `gift_registry_item_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { - "gift_registry_item_uid": 4, + "gift_registry_item_uid": "4", "note": "xyz789", - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -300,7 +300,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -318,7 +318,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -336,11 +336,11 @@ Defines updates to an existing registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | -| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/2-4-8/types-f-i.md#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`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -350,9 +350,9 @@ Defines updates to an existing registrant. GiftRegistryDynamicAttributeInput ], "email": "xyz789", - "firstname": "abc123", - "gift_registry_registrant_uid": "4", - "lastname": "abc123" + "firstname": "xyz789", + "gift_registry_registrant_uid": 4, + "lastname": "xyz789" } ``` @@ -366,7 +366,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/2-4-8/types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -384,7 +384,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/2-4-8/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -402,8 +402,8 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](/reference/graphql/2-4-8/types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -424,7 +424,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -442,15 +442,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](/reference/graphql/2-4-8/types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": 4 + "template_id": "4" } ``` @@ -486,25 +486,25 @@ Defines the changes to be made to an approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | -| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | +| `applies_to` - [`[ID]`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](/reference/graphql/2-4-8/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](/reference/graphql/2-4-8/types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { - "applies_to": ["4"], - "approvers": [4], + "applies_to": [4], + "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", + "description": "abc123", "name": "abc123", "status": "ENABLED", - "uid": 4 + "uid": "4" } ``` @@ -518,15 +518,15 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The new name of the requisition list. | #### Example ```json { "description": "xyz789", - "name": "xyz789" + "name": "abc123" } ``` @@ -540,17 +540,17 @@ Defines which items in a requisition list to update. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-8/types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](/reference/graphql/2-4-8/types-q-s.md#string) | An array of selected option IDs. | #### Example ```json { "entered_options": [EnteredOptionInput], - "item_id": 4, + "item_id": "4", "quantity": 123.45, "selected_options": ["xyz789"] } @@ -566,7 +566,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -584,7 +584,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/2-4-8/types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -602,8 +602,8 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The wish list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of a `Wishlist` object. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -626,15 +626,15 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](types-q-s.md#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](/reference/graphql/2-4-8/types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The request URL. | #### Example ```json { "parameters": [HttpQueryParameter], - "url": "xyz789" + "url": "abc123" } ``` @@ -688,16 +688,16 @@ Defines the input for returning matching companies the customer is assigned to. | Input Field | Description | |-------------|-------------| -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | -| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | +| `currentPage` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](/reference/graphql/2-4-8/types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example ```json { - "currentPage": 987, - "pageSize": 987, + "currentPage": 123, + "pageSize": 123, "sort": [CompaniesSortInput] } ``` @@ -712,8 +712,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](/reference/graphql/2-4-8/types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -734,7 +734,7 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example @@ -773,7 +773,7 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of the purchase order IDs. | #### Example @@ -792,7 +792,7 @@ Contains the results of validation attempts. | Field Name | Description | |------------|-------------| | `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | +| `purchase_orders` - [`[PurchaseOrder]!`](/reference/graphql/2-4-8/types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -814,7 +814,7 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](types-q-s.md#string) | Validation rule value. | +| `value` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Validation rule value. | #### Example @@ -877,8 +877,8 @@ Retrieves the vault configuration | Field Name | Description | |------------|-------------| -| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | +| `is_vault_enabled` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/2-4-8/types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | | `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | #### Example @@ -901,10 +901,10 @@ Vault payment inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | +| `payment_source` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The public hash of the token. | #### Example @@ -912,7 +912,7 @@ Vault payment inputs { "payment_source": "xyz789", "payments_order_id": "abc123", - "paypal_order_id": "abc123", + "paypal_order_id": "xyz789", "public_hash": "abc123" } ``` @@ -927,7 +927,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](types-k-p.md#paymentsourceinput) | The payment source information | +| `payment_source` - [`PaymentSourceInput!`](/reference/graphql/2-4-8/types-k-p.md#paymentsourceinput) | The payment source information | #### Example @@ -945,7 +945,7 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The public hash of the payment token. | #### Example @@ -963,20 +963,20 @@ An implementation for virtual product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/2-4-8/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/2-4-8/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/2-4-8/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/2-4-8/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -985,17 +985,17 @@ An implementation for virtual product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "xyz789", - "is_available": true, - "max_qty": 987.65, + "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" + "quantity": 123.45, + "uid": 4 } ``` @@ -1009,89 +1009,89 @@ Defines a virtual product, which is a non-tangible product that does not require | Field Name | Description | |------------|-------------| -| `activity` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `activity` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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]`](/reference/graphql/2-4-8/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/2-4-8/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/2-4-8/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/2-4-8/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/2-4-8/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](/reference/graphql/2-4-8/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/2-4-8/types-k-p.md#pricerange) | The range of prices for the product | | `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/2-4-8/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/2-4-8/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/2-4-8/types-k-p.md#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](/reference/graphql/2-4-8/types-c-e.md#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](/reference/graphql/2-4-8/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/2-4-8/types-k-p.md#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/2-4-8/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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]`](/reference/graphql/2-4-8/types-k-p.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `type_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | | `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `url_suffix` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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 @@ -1099,24 +1099,24 @@ Defines a virtual product, which is a non-tangible product that does not require ```json { "activity": "xyz789", - "attribute_set_id": 987, + "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], "category_gear": "abc123", "climate": "xyz789", - "collar": "abc123", + "collar": "xyz789", "color": 123, - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "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_message_available": true, + "eco_collection": 987, + "erin_recommends": 123, + "features_bags": "xyz789", + "format": 123, + "gender": "xyz789", + "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, "id": 987, @@ -1124,12 +1124,12 @@ Defines a virtual product, which is a non-tangible product that does not require "is_returnable": "abc123", "manufacturer": 987, "material": "abc123", - "max_sale_qty": 987.65, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", "min_sale_qty": 123.45, "name": "xyz789", "new": 123, @@ -1137,50 +1137,50 @@ Defines a virtual product, which is a non-tangible product that does not require "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "abc123", - "performance_fabric": 987, + "options_container": "xyz789", + "pattern": "xyz789", + "performance_fabric": 123, "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "purpose": 987, - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 987.65, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, + "relative_url": "xyz789", + "review_count": 123, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, - "size": 123, - "sku": "xyz789", - "sleeve": "abc123", + "size": 987, + "sku": "abc123", + "sleeve": "xyz789", "small_image": ProductImage, "special_from_date": "abc123", "special_price": 987.65, - "special_to_date": "abc123", + "special_to_date": "xyz789", "staged": false, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", - "style_bags": "abc123", + "strap_bags": "abc123", + "style_bags": "xyz789", "style_bottom": "abc123", "style_general": "xyz789", "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": "4", - "updated_at": "abc123", + "uid": 4, + "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "abc123", + "url_key": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website] } ``` @@ -1195,8 +1195,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/2-4-8/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/2-4-8/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -1217,10 +1217,10 @@ Contains details about virtual products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1243,21 +1243,21 @@ Contains a virtual product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": "4", + "id": 4, "product": ProductInterface, "quantity": 987.65 } @@ -1273,12 +1273,12 @@ Deprecated. It should not be used on the storefront. Contains information about | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](types-q-s.md#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`](types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | +| `code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](/reference/graphql/2-4-8/types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](/reference/graphql/2-4-8/types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | #### Example @@ -1304,14 +1304,14 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -1344,22 +1344,22 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `Wishlist` object. | | `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. | +| `items_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#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`](types-q-s.md#string) | The name of the wish list. | -| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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", + "id": 4, "items": [WishlistItem], - "items_count": 123, + "items_count": 987, "items_v2": WishlistItems, "name": "abc123", "sharing_code": "xyz789", @@ -1379,16 +1379,16 @@ Contains details about errors encountered when a customer added wish list items | Field Name | Description | |------------|-------------| | `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | +| `message` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", + "message": "abc123", "wishlistId": "4", "wishlistItemId": 4 } @@ -1425,21 +1425,21 @@ Contains details about a wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | +| `added_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "description": "xyz789", - "id": 987, + "id": 123, "product": ProductInterface, - "qty": 123.45 + "qty": 987.65 } ``` @@ -1453,8 +1453,8 @@ Specifies the IDs of items to copy and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example @@ -1475,11 +1475,11 @@ Defines the items to add to a wish list. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-8/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | #### Example @@ -1488,8 +1488,8 @@ Defines the items to add to a wish list. "entered_options": [EnteredOptionInput], "parent_sku": "abc123", "quantity": 123.45, - "selected_options": ["4"], - "sku": "abc123" + "selected_options": [4], + "sku": "xyz789" } ``` @@ -1503,35 +1503,35 @@ The interface for wish list items. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/2-4-8/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/2-4-8/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/2-4-8/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/2-4-8/types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | +| [`SimpleWishlistItem`](/reference/graphql/2-4-8/types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | -| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | -| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | -| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](/reference/graphql/2-4-8/types-c-e.md#configurablewishlistitem) | +| [`BundleWishlistItem`](/reference/graphql/2-4-8/types-a-b.md#bundlewishlistitem) | +| [`DownloadableWishlistItem`](/reference/graphql/2-4-8/types-c-e.md#downloadablewishlistitem) | +| [`GiftCardWishlistItem`](/reference/graphql/2-4-8/types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](/reference/graphql/2-4-8/types-f-i.md#groupedproductwishlistitem) | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": 4, + "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1545,14 +1545,14 @@ Specifies the IDs of the items to move and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#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!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json { - "quantity": 123.45, + "quantity": 987.65, "wishlist_item_id": "4" } ``` @@ -1567,11 +1567,11 @@ Defines updates to items in a wish list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `description` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/2-4-8/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](/reference/graphql/2-4-8/types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](/reference/graphql/2-4-8/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](/reference/graphql/2-4-8/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example @@ -1579,9 +1579,9 @@ Defines updates to items in a wish list. { "description": "abc123", "entered_options": [EnteredOptionInput], - "quantity": 123.45, - "selected_options": ["4"], - "wishlist_item_id": "4" + "quantity": 987.65, + "selected_options": [4], + "wishlist_item_id": 4 } ``` @@ -1596,7 +1596,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/2-4-8/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1618,10 +1618,10 @@ Deprecated: Use the `Wishlist` type instead. | 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`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | +| `items_count` - [`Int`](/reference/graphql/2-4-8/types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](/reference/graphql/2-4-8/types-q-s.md#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`](/reference/graphql/2-4-8/types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](/reference/graphql/2-4-8/types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | #### Example @@ -1629,7 +1629,7 @@ Deprecated: Use the `Wishlist` type instead. { "items": [WishlistItem], "items_count": 123, - "name": "xyz789", + "name": "abc123", "sharing_code": "abc123", "updated_at": "xyz789" } 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 d0fe05ec9..8b4020ec8 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 @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](/reference/graphql/latest/types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](/reference/graphql/latest/types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": true}}} +{"data": {"acceptCompanyInvitation": {"success": false}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](/reference/graphql/latest/types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -108,12 +108,12 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -124,9 +124,9 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -138,13 +138,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddBundleProductsToCartOutput`](types-a-b.md#addbundleproductstocartoutput) +**Response:** [`AddBundleProductsToCartOutput`](/reference/graphql/latest/types-a-b.md#addbundleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddBundleProductsToCartInput`](types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | +| `input` - [`AddBundleProductsToCartInput`](/reference/graphql/latest/types-a-b.md#addbundleproductstocartinput) | An input object that defines which bundle products to add to the cart. | #### Example @@ -178,13 +178,13 @@ mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) { Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddConfigurableProductsToCartOutput`](types-a-b.md#addconfigurableproductstocartoutput) +**Response:** [`AddConfigurableProductsToCartOutput`](/reference/graphql/latest/types-a-b.md#addconfigurableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddConfigurableProductsToCartInput`](types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | +| `input` - [`AddConfigurableProductsToCartInput`](/reference/graphql/latest/types-a-b.md#addconfigurableproductstocartinput) | An input object that defines which configurable products to add to the cart. | #### Example @@ -222,13 +222,13 @@ mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](/reference/graphql/latest/types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](/reference/graphql/latest/types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -266,14 +266,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](/reference/graphql/latest/types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](/reference/graphql/latest/types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -299,7 +299,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -322,14 +322,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/latest/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](/reference/graphql/latest/types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -358,7 +358,7 @@ mutation addProductsToCart( ```json { - "cartId": "abc123", + "cartId": "xyz789", "cartItems": [CartItemInput] } ``` @@ -382,13 +382,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/latest/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](/reference/graphql/latest/types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -424,7 +424,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -436,13 +436,13 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Creates a new cart and add any type of product to it -**Response:** [`AddProductsToNewCartOutput`](types-a-b.md#addproductstonewcartoutput) +**Response:** [`AddProductsToNewCartOutput`](/reference/graphql/latest/types-a-b.md#addproductstonewcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the new cart | +| `cartItems` - [`[CartItemInput!]!`](/reference/graphql/latest/types-c-e.md#cartiteminput) | An array that defines the products to add to the new cart | #### Example @@ -486,14 +486,14 @@ mutation addProductsToNewCart($cartItems: [CartItemInput!]!) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](/reference/graphql/latest/types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](/reference/graphql/latest/types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -542,14 +542,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](/reference/graphql/latest/types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](/reference/graphql/latest/types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -577,7 +577,10 @@ mutation addProductsToWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} +{ + "wishlistId": "4", + "wishlistItems": [WishlistItemInput] +} ``` ##### Response @@ -599,13 +602,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](/reference/graphql/latest/types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](/reference/graphql/latest/types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -645,13 +648,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/latest/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](/reference/graphql/latest/types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -695,14 +698,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](/reference/graphql/latest/types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](/reference/graphql/latest/types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -732,8 +735,8 @@ mutation addRequisitionListItemsToCart( ```json { - "requisitionListUid": "4", - "requisitionListItemUids": [4] + "requisitionListUid": 4, + "requisitionListItemUids": ["4"] } ``` @@ -747,7 +750,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } } } @@ -759,13 +762,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](/reference/graphql/latest/types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](/reference/graphql/latest/types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -799,13 +802,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](/reference/graphql/latest/types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](/reference/graphql/latest/types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -849,13 +852,13 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddSimpleProductsToCartOutput`](types-a-b.md#addsimpleproductstocartoutput) +**Response:** [`AddSimpleProductsToCartOutput`](/reference/graphql/latest/types-a-b.md#addsimpleproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddSimpleProductsToCartInput`](types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | +| `input` - [`AddSimpleProductsToCartInput`](/reference/graphql/latest/types-a-b.md#addsimpleproductstocartinput) | An input object that defines which simple products to add to the cart. | #### Example @@ -889,13 +892,13 @@ mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) { Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddVirtualProductsToCartOutput`](types-a-b.md#addvirtualproductstocartoutput) +**Response:** [`AddVirtualProductsToCartOutput`](/reference/graphql/latest/types-a-b.md#addvirtualproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddVirtualProductsToCartInput`](types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | +| `input` - [`AddVirtualProductsToCartInput`](/reference/graphql/latest/types-a-b.md#addvirtualproductstocartinput) | An input object that defines which virtual products to add to the cart. | #### Example @@ -929,14 +932,14 @@ mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](/reference/graphql/latest/types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](/reference/graphql/latest/types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -965,7 +968,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": "4", "wishlistItemIds": [4]} +{"wishlistId": 4, "wishlistItemIds": ["4"]} ``` ##### Response @@ -990,13 +993,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/latest/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](/reference/graphql/latest/types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1030,13 +1033,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/latest/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](/reference/graphql/latest/types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -1070,13 +1073,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](/reference/graphql/latest/types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](/reference/graphql/latest/types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -1110,13 +1113,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](/reference/graphql/latest/types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -1135,7 +1138,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -1150,13 +1153,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](/reference/graphql/latest/types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](/reference/graphql/latest/types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1190,13 +1193,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/latest/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/latest/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1240,13 +1243,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](/reference/graphql/latest/types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1276,7 +1279,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": false + "result": true } } } @@ -1288,13 +1291,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -1364,7 +1367,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` ##### Response @@ -1383,16 +1386,16 @@ mutation assignCustomerToGuestCart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "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": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -1408,13 +1411,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](/reference/graphql/latest/types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1476,12 +1479,12 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "comments": [NegotiableQuoteComment], "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": 123, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1491,7 +1494,7 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", + "template_id": 4, "total_quantity": 123.45 } } @@ -1504,13 +1507,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/latest/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](/reference/graphql/latest/types-c-e.md#cancelorderinput) | | #### Example @@ -1542,7 +1545,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1556,13 +1559,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/latest/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/latest/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1606,14 +1609,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/latest/types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | +| `currentPassword` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's updated password. | #### Example @@ -1737,7 +1740,7 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "abc123", + "currentPassword": "xyz789", "newPassword": "abc123" } ``` @@ -1750,30 +1753,30 @@ mutation changeCustomerPassword( "changeCustomerPassword": { "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": "abc123", "custom_attributes": [AttributeValueInterface], "date_of_birth": "xyz789", - "default_billing": "abc123", - "default_shipping": "abc123", + "default_billing": "xyz789", + "default_shipping": "xyz789", "dob": "xyz789", "email": "xyz789", - "firstname": "xyz789", - "gender": 987, + "firstname": "abc123", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "group_id": 123, - "id": 4, + "group_id": 987, + "id": "4", "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, @@ -1790,8 +1793,8 @@ mutation changeCustomerPassword( "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "xyz789", - "taxvat": "xyz789", + "suffix": "abc123", + "taxvat": "abc123", "team": CompanyTeam, "telephone": "xyz789", "wishlist": Wishlist, @@ -1808,13 +1811,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCartOutput!`](types-c-e.md#clearcartoutput) +**Response:** [`ClearCartOutput!`](/reference/graphql/latest/types-c-e.md#clearcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ClearCartInput!`](types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | +| `input` - [`ClearCartInput!`](/reference/graphql/latest/types-c-e.md#clearcartinput) | An input object that defines cart ID of the shopper. | #### Example @@ -1858,13 +1861,13 @@ mutation clearCart($input: ClearCartInput!) { Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](/reference/graphql/latest/types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1903,13 +1906,13 @@ mutation clearCustomerCart($cartUid: String!) { Remove all the products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](/reference/graphql/latest/types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of a wish list. | #### Example @@ -1953,13 +1956,13 @@ mutation clearWishlist($wishlistId: ID!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](/reference/graphql/latest/types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](/reference/graphql/latest/types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -2016,13 +2019,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Synchronizes order details and place the order -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/latest/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompleteOrderInput`](types-c-e.md#completeorderinput) | Describes the variables needed to complete or place the order | +| `input` - [`CompleteOrderInput`](/reference/graphql/latest/types-c-e.md#completeorderinput) | Describes the variables needed to complete or place the order | #### Example @@ -2070,13 +2073,13 @@ mutation completeOrder($input: CompleteOrderInput) { Cancel the specified guest customer order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/latest/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmCancelOrderInput!`](types-c-e.md#confirmcancelorderinput) | | +| `input` - [`ConfirmCancelOrderInput!`](/reference/graphql/latest/types-c-e.md#confirmcancelorderinput) | | #### Example @@ -2108,7 +2111,7 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { { "data": { "confirmCancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -2122,13 +2125,13 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/latest/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](/reference/graphql/latest/types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -2162,13 +2165,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Confirm the return. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/latest/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmReturnInput!`](types-c-e.md#confirmreturninput) | | +| `input` - [`ConfirmReturnInput!`](/reference/graphql/latest/types-c-e.md#confirmreturninput) | | #### Example @@ -2212,13 +2215,13 @@ mutation confirmReturn($input: ConfirmReturnInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) +**Response:** [`ContactUsOutput`](/reference/graphql/latest/types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](/reference/graphql/latest/types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -2250,15 +2253,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](/reference/graphql/latest/types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](/reference/graphql/latest/types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2287,7 +2290,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": "4", + "destinationRequisitionListUid": 4, "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2310,15 +2313,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](/reference/graphql/latest/types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](/reference/graphql/latest/types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2353,7 +2356,7 @@ mutation copyProductsBetweenWishlists( ```json { "sourceWishlistUid": 4, - "destinationWishlistUid": 4, + "destinationWishlistUid": "4", "wishlistItems": [WishlistItemCopyInput] } ``` @@ -2378,7 +2381,7 @@ mutation copyProductsBetweenWishlists( Creates Client Token for Braintree Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/latest/types-q-s.md#string) #### Example @@ -2395,7 +2398,7 @@ mutation createBraintreeClientToken { ```json { "data": { - "createBraintreeClientToken": "abc123" + "createBraintreeClientToken": "xyz789" } } ``` @@ -2406,7 +2409,7 @@ mutation createBraintreeClientToken { Creates Client Token for Braintree PayPal Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/latest/types-q-s.md#string) #### Example @@ -2423,7 +2426,7 @@ mutation createBraintreePayPalClientToken { ```json { "data": { - "createBraintreePayPalClientToken": "abc123" + "createBraintreePayPalClientToken": "xyz789" } } ``` @@ -2434,13 +2437,13 @@ mutation createBraintreePayPalClientToken { Creates Client Token for Braintree PayPal Vault Javascript SDK initialization. -**Response:** [`String!`](types-q-s.md#string) +**Response:** [`String!`](/reference/graphql/latest/types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | +| `input` - [`BraintreeVaultInput`](/reference/graphql/latest/types-a-b.md#braintreevaultinput) | | #### Example @@ -2474,13 +2477,13 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](/reference/graphql/latest/types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](/reference/graphql/latest/types-c-e.md#companycreateinput) | | #### Example @@ -2514,13 +2517,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](/reference/graphql/latest/types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](/reference/graphql/latest/types-c-e.md#companyrolecreateinput) | | #### Example @@ -2554,13 +2557,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](/reference/graphql/latest/types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](/reference/graphql/latest/types-c-e.md#companyteamcreateinput) | | #### Example @@ -2594,13 +2597,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](/reference/graphql/latest/types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](/reference/graphql/latest/types-c-e.md#companyusercreateinput) | | #### Example @@ -2634,13 +2637,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/latest/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](/reference/graphql/latest/types-c-e.md#createcomparelistinput) | | #### Example @@ -2690,13 +2693,13 @@ mutation createCompareList($input: CreateCompareListInput) { Use `createCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/latest/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerInput!`](/reference/graphql/latest/types-c-e.md#customerinput) | An input object that defines the customer to be created. | #### Example @@ -2730,13 +2733,13 @@ mutation createCustomer($input: CustomerInput!) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/latest/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](/reference/graphql/latest/types-c-e.md#customeraddressinput) | | #### Example @@ -2794,29 +2797,29 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "data": { "createCustomerAddress": { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 987, - "default_billing": true, + "customer_id": 123, + "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", - "id": 987, + "fax": "xyz789", + "firstname": "xyz789", + "id": 123, "lastname": "abc123", "middlename": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "xyz789", - "uid": "4", - "vat_id": "abc123" + "uid": 4, + "vat_id": "xyz789" } } } @@ -2828,13 +2831,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/latest/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](/reference/graphql/latest/types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2872,13 +2875,13 @@ Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer Create an empty shopping cart for a guest or logged in user -**Response:** [`String`](types-q-s.md#string) +**Response:** [`String`](/reference/graphql/latest/types-q-s.md#string) #### Arguments | Name | Description | |------|-------------| -| `input` - [`createEmptyCartInput`](types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | +| `input` - [`createEmptyCartInput`](/reference/graphql/latest/types-c-e.md#createemptycartinput) | An optional input object that assigns the specified ID to the cart. | #### Example @@ -2908,13 +2911,13 @@ mutation createEmptyCart($input: createEmptyCartInput) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](/reference/graphql/latest/types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](/reference/graphql/latest/types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2952,13 +2955,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](/reference/graphql/latest/types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](/reference/graphql/latest/types-c-e.md#createguestcartinput) | | #### Example @@ -2992,13 +2995,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods -**Response:** [`CreatePayflowProTokenOutput`](types-c-e.md#createpayflowprotokenoutput) +**Response:** [`CreatePayflowProTokenOutput`](/reference/graphql/latest/types-c-e.md#createpayflowprotokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProTokenInput!`](types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | +| `input` - [`PayflowProTokenInput!`](/reference/graphql/latest/types-k-p.md#payflowprotokeninput) | An input object that defines the requirements to fetch payment token information. | #### Example @@ -3028,11 +3031,11 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "abc123", - "result": 987, + "response_message": "xyz789", + "result": 123, "result_code": 123, - "secure_token": "xyz789", - "secure_token_id": "xyz789" + "secure_token": "abc123", + "secure_token_id": "abc123" } } } @@ -3044,13 +3047,13 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](/reference/graphql/latest/types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](/reference/graphql/latest/types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -3080,8 +3083,8 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 123.45, - "currency_code": "xyz789", + "amount": 987.65, + "currency_code": "abc123", "id": "xyz789", "mp_order_id": "abc123", "status": "xyz789" @@ -3096,13 +3099,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods. -**Response:** [`PaypalExpressTokenOutput`](types-k-p.md#paypalexpresstokenoutput) +**Response:** [`PaypalExpressTokenOutput`](/reference/graphql/latest/types-k-p.md#paypalexpresstokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PaypalExpressTokenInput!`](types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PaypalExpressTokenInput!`](/reference/graphql/latest/types-k-p.md#paypalexpresstokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -3132,7 +3135,7 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { "data": { "createPaypalExpressToken": { "paypal_urls": PaypalExpressUrlList, - "token": "abc123" + "token": "xyz789" } } } @@ -3144,13 +3147,13 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { Create a product review for the specified product. -**Response:** [`CreateProductReviewOutput!`](types-c-e.md#createproductreviewoutput) +**Response:** [`CreateProductReviewOutput!`](/reference/graphql/latest/types-c-e.md#createproductreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateProductReviewInput!`](types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | +| `input` - [`CreateProductReviewInput!`](/reference/graphql/latest/types-c-e.md#createproductreviewinput) | An input object that contains the details necessary to create a product review. | #### Example @@ -3188,13 +3191,13 @@ mutation createProductReview($input: CreateProductReviewInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -3240,11 +3243,11 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "abc123", - "description": "abc123", + "description": "xyz789", "name": "abc123", "status": "ENABLED", - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } } } @@ -3256,13 +3259,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](/reference/graphql/latest/types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](/reference/graphql/latest/types-c-e.md#createrequisitionlistinput) | | #### Example @@ -3302,13 +3305,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Creates a vault payment token -**Response:** [`CreateVaultCardPaymentTokenOutput`](types-c-e.md#createvaultcardpaymenttokenoutput) +**Response:** [`CreateVaultCardPaymentTokenOutput`](/reference/graphql/latest/types-c-e.md#createvaultcardpaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardPaymentTokenInput!`](types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | +| `input` - [`CreateVaultCardPaymentTokenInput!`](/reference/graphql/latest/types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | #### Example @@ -3338,7 +3341,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } } } @@ -3350,13 +3353,13 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) Creates a vault card setup token -**Response:** [`CreateVaultCardSetupTokenOutput`](types-c-e.md#createvaultcardsetuptokenoutput) +**Response:** [`CreateVaultCardSetupTokenOutput`](/reference/graphql/latest/types-c-e.md#createvaultcardsetuptokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardSetupTokenInput!`](types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | +| `input` - [`CreateVaultCardSetupTokenInput!`](/reference/graphql/latest/types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | #### Example @@ -3382,7 +3385,7 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { { "data": { "createVaultCardSetupToken": { - "setup_token": "xyz789" + "setup_token": "abc123" } } } @@ -3394,13 +3397,13 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](/reference/graphql/latest/types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](/reference/graphql/latest/types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -3434,13 +3437,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](/reference/graphql/latest/types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -3457,13 +3460,13 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyRole": {"success": false}}} +{"data": {"deleteCompanyRole": {"success": true}}} ``` @@ -3472,13 +3475,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](/reference/graphql/latest/types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -3501,7 +3504,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": true}}} +{"data": {"deleteCompanyTeam": {"success": false}}} ``` @@ -3514,13 +3517,13 @@ Use deleteCompanyUserV2 instead. The current method only deactivates the user ac Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/latest/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -3543,7 +3546,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyUser": {"success": true}}} +{"data": {"deleteCompanyUser": {"success": false}}} ``` @@ -3552,13 +3555,13 @@ mutation deleteCompanyUser($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/latest/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -3575,7 +3578,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3590,13 +3593,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](/reference/graphql/latest/types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3628,7 +3631,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) #### Example @@ -3656,13 +3659,13 @@ Use `deleteCustomerAddressV2` instead. Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3677,13 +3680,13 @@ mutation deleteCustomerAddress($id: Int!) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response ```json -{"data": {"deleteCustomerAddress": true}} +{"data": {"deleteCustomerAddress": false}} ``` @@ -3692,13 +3695,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address to be deleted. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the customer address to be deleted. | #### Example @@ -3713,7 +3716,7 @@ mutation deleteCustomerAddressV2($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -3728,13 +3731,13 @@ mutation deleteCustomerAddressV2($uid: ID!) { Delete a negotiable quote template -**Response:** [`Boolean!`](types-a-b.md#boolean) +**Response:** [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](/reference/graphql/latest/types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3764,13 +3767,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](/reference/graphql/latest/types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](/reference/graphql/latest/types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3823,13 +3826,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](/reference/graphql/latest/types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3849,7 +3852,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "abc123"} +{"public_hash": "xyz789"} ``` ##### Response @@ -3859,7 +3862,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } } } @@ -3871,13 +3874,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](/reference/graphql/latest/types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](/reference/graphql/latest/types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3917,13 +3920,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](/reference/graphql/latest/types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3965,14 +3968,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](/reference/graphql/latest/types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](/reference/graphql/latest/types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -3997,10 +4000,7 @@ mutation deleteRequisitionListItems( ##### Variables ```json -{ - "requisitionListUid": "4", - "requisitionListItemUids": [4] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -4021,13 +4021,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](/reference/graphql/latest/types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -4047,7 +4047,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": "4"} +{"wishlistId": 4} ``` ##### Response @@ -4056,7 +4056,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": true, + "status": false, "wishlists": [Wishlist] } } @@ -4069,13 +4069,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](/reference/graphql/latest/types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](/reference/graphql/latest/types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -4113,13 +4113,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](/reference/graphql/latest/types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/latest/types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -4164,12 +4164,12 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "estimateShippingMethods": [ { "amount": Money, - "available": true, + "available": false, "base_amount": Money, "carrier_code": "xyz789", "carrier_title": "abc123", "error_message": "abc123", - "method_code": "xyz789", + "method_code": "abc123", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -4185,13 +4185,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](/reference/graphql/latest/types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/latest/types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -4225,13 +4225,13 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`ExchangeExternalCustomerTokenOutput`](types-c-e.md#exchangeexternalcustomertokenoutput) +**Response:** [`ExchangeExternalCustomerTokenOutput`](/reference/graphql/latest/types-c-e.md#exchangeexternalcustomertokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ExchangeExternalCustomerTokenInput`](types-c-e.md#exchangeexternalcustomertokeninput) | Contains details about external customer. | +| `input` - [`ExchangeExternalCustomerTokenInput`](/reference/graphql/latest/types-c-e.md#exchangeexternalcustomertokeninput) | Contains details about external customer. | #### Example @@ -4273,14 +4273,14 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu Generate a token for specified customer. -**Response:** [`CustomerToken`](types-c-e.md#customertoken) +**Response:** [`CustomerToken`](/reference/graphql/latest/types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's password. | #### Example @@ -4305,7 +4305,7 @@ mutation generateCustomerToken( ```json { "email": "abc123", - "password": "xyz789" + "password": "abc123" } ``` @@ -4327,13 +4327,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](/reference/graphql/latest/types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](/reference/graphql/latest/types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -4359,7 +4359,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "abc123" + "customer_token": "xyz789" } } } @@ -4371,13 +4371,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](/reference/graphql/latest/types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](/reference/graphql/latest/types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -4409,13 +4409,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods. -**Response:** [`PayflowProResponseOutput`](types-k-p.md#payflowproresponseoutput) +**Response:** [`PayflowProResponseOutput`](/reference/graphql/latest/types-k-p.md#payflowproresponseoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowProResponseInput!`](types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | +| `input` - [`PayflowProResponseInput!`](/reference/graphql/latest/types-k-p.md#payflowproresponseinput) | An input object that includes the payload returned by PayPal and the cart ID. | #### Example @@ -4449,14 +4449,14 @@ mutation handlePayflowProResponse($input: PayflowProResponseInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | -| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | +| `source_cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4533,7 +4533,7 @@ mutation mergeCarts( ```json { - "source_cart_id": "xyz789", + "source_cart_id": "abc123", "destination_cart_id": "xyz789" } ``` @@ -4554,20 +4554,20 @@ 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": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -4579,14 +4579,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/latest/types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4615,10 +4615,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{ - "cartUid": "4", - "giftRegistryUid": "4" -} +{"cartUid": "4", "giftRegistryUid": 4} ``` ##### Response @@ -4628,7 +4625,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } } @@ -4641,15 +4638,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](/reference/graphql/latest/types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](/reference/graphql/latest/types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4680,7 +4677,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, + "sourceRequisitionListUid": "4", "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } @@ -4705,13 +4702,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](/reference/graphql/latest/types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](/reference/graphql/latest/types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4751,15 +4748,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](/reference/graphql/latest/types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](/reference/graphql/latest/types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4819,13 +4816,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](/reference/graphql/latest/types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4885,14 +4882,14 @@ 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, + "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, "reference_document_links": [ @@ -4901,9 +4898,9 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -4915,13 +4912,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](/reference/graphql/latest/types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](/reference/graphql/latest/types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4955,13 +4952,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/latest/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](/reference/graphql/latest/types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -5009,13 +5006,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](/reference/graphql/latest/types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](/reference/graphql/latest/types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -5053,13 +5050,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](/reference/graphql/latest/types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](/reference/graphql/latest/types-k-p.md#placepurchaseorderinput) | | #### Example @@ -5099,13 +5096,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/latest/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/latest/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -5136,8 +5133,8 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "abc123", - "expiration_date": "xyz789" + "code": "xyz789", + "expiration_date": "abc123" } } } @@ -5149,13 +5146,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/latest/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/latest/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -5199,13 +5196,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/latest/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](/reference/graphql/latest/types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -5239,13 +5236,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/latest/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](/reference/graphql/latest/types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -5279,13 +5276,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](/reference/graphql/latest/types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](/reference/graphql/latest/types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -5319,13 +5316,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](/reference/graphql/latest/types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -5357,14 +5354,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](/reference/graphql/latest/types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](/reference/graphql/latest/types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -5389,7 +5386,10 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": "4", "itemsUid": [4]} +{ + "giftRegistryUid": "4", + "itemsUid": ["4"] +} ``` ##### Response @@ -5410,14 +5410,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](/reference/graphql/latest/types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](/reference/graphql/latest/types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -5443,8 +5443,8 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, - "registrantsUid": ["4"] + "giftRegistryUid": "4", + "registrantsUid": [4] } ``` @@ -5466,13 +5466,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](/reference/graphql/latest/types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](/reference/graphql/latest/types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5506,13 +5506,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](/reference/graphql/latest/types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](/reference/graphql/latest/types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5552,13 +5552,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](/reference/graphql/latest/types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5618,14 +5618,14 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": false, + "is_min_max_qty_used": true, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -5635,7 +5635,7 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -5648,13 +5648,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/latest/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](/reference/graphql/latest/types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5702,14 +5702,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](/reference/graphql/latest/types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](/reference/graphql/latest/types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5737,7 +5737,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": ["4"]} +{"wishlistId": "4", "wishlistItemsIds": [4]} ``` ##### Response @@ -5759,13 +5759,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](/reference/graphql/latest/types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](/reference/graphql/latest/types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5799,13 +5799,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](/reference/graphql/latest/types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -5824,7 +5824,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -5839,13 +5839,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](/reference/graphql/latest/types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](/reference/graphql/latest/types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5879,13 +5879,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](/reference/graphql/latest/types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](/reference/graphql/latest/types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5923,13 +5923,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](/reference/graphql/latest/types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](types-q-s.md#string) | | +| `orderNumber` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -5951,7 +5951,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "abc123"} +{"orderNumber": "xyz789"} ``` ##### Response @@ -5973,13 +5973,13 @@ mutation reorderItems($orderNumber: String!) { Request to cancel specified guest order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/latest/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderCancelInput!`](types-f-i.md#guestordercancelinput) | | +| `input` - [`GuestOrderCancelInput!`](/reference/graphql/latest/types-f-i.md#guestordercancelinput) | | #### Example @@ -6011,7 +6011,7 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { { "data": { "requestGuestOrderCancel": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -6023,13 +6023,13 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { ### requestGuestReturn -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/latest/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestGuestReturnInput!`](types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | +| `input` - [`RequestGuestReturnInput!`](/reference/graphql/latest/types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | #### Example @@ -6073,13 +6073,13 @@ mutation requestGuestReturn($input: RequestGuestReturnInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](/reference/graphql/latest/types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](/reference/graphql/latest/types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -6117,13 +6117,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](/reference/graphql/latest/types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -6183,14 +6183,14 @@ 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, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6213,13 +6213,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's email address. | #### Example @@ -6249,13 +6249,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/latest/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](/reference/graphql/latest/types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -6299,13 +6299,13 @@ mutation requestReturn($input: RequestReturnInput!) { Resends the confirmation email to a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to send the confirmation email to. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address to send the confirmation email to. | #### Example @@ -6320,7 +6320,7 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -6335,15 +6335,15 @@ mutation resendConfirmationEmail($email: String!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's new password. | #### Example @@ -6367,16 +6367,16 @@ mutation resetPassword( ```json { - "email": "abc123", + "email": "xyz789", "resetPasswordToken": "xyz789", - "newPassword": "xyz789" + "newPassword": "abc123" } ``` ##### Response ```json -{"data": {"resetPassword": false}} +{"data": {"resetPassword": true}} ``` @@ -6385,7 +6385,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](/reference/graphql/latest/types-q-s.md#revokecustomertokenoutput) #### Example @@ -6411,13 +6411,13 @@ mutation revokeCustomerToken { Send a message on behalf of a customer to the specified email addresses. -**Response:** [`SendEmailToFriendOutput`](types-q-s.md#sendemailtofriendoutput) +**Response:** [`SendEmailToFriendOutput`](/reference/graphql/latest/types-q-s.md#sendemailtofriendoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendEmailToFriendInput`](types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | +| `input` - [`SendEmailToFriendInput`](/reference/graphql/latest/types-q-s.md#sendemailtofriendinput) | An input object that defines sender, recipients, and product. | #### Example @@ -6461,13 +6461,13 @@ mutation sendEmailToFriend($input: SendEmailToFriendInput) { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](/reference/graphql/latest/types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](/reference/graphql/latest/types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -6507,13 +6507,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](/reference/graphql/latest/types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](/reference/graphql/latest/types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -6547,13 +6547,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Sets the cart as inactive -**Response:** [`SetCartAsInactiveOutput`](types-q-s.md#setcartasinactiveoutput) +**Response:** [`SetCartAsInactiveOutput`](/reference/graphql/latest/types-q-s.md#setcartasinactiveoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `cartId` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer cart ID | #### Example @@ -6581,7 +6581,7 @@ mutation setCartAsInactive($cartId: String!) { "data": { "setCartAsInactive": { "error": "abc123", - "success": false + "success": true } } } @@ -6593,13 +6593,13 @@ mutation setCartAsInactive($cartId: String!) { Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](/reference/graphql/latest/types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](/reference/graphql/latest/types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -6633,13 +6633,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](/reference/graphql/latest/types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](/reference/graphql/latest/types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6673,13 +6673,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](/reference/graphql/latest/types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](/reference/graphql/latest/types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6713,13 +6713,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](/reference/graphql/latest/types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](/reference/graphql/latest/types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6759,13 +6759,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](/reference/graphql/latest/types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](/reference/graphql/latest/types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6805,13 +6805,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](/reference/graphql/latest/types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](/reference/graphql/latest/types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6851,13 +6851,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](/reference/graphql/latest/types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](/reference/graphql/latest/types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6897,13 +6897,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/latest/types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6963,13 +6963,13 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": false, + "is_min_max_qty_used": true, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 123, + "max_order_commitment": 987, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -6979,9 +6979,9 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -6997,13 +6997,13 @@ Should use setPaymentMethodOnCart and placeOrder mutations in single request. Set the cart payment method and convert the cart into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/latest/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodAndPlaceOrderInput`](types-q-s.md#setpaymentmethodandplaceorderinput) | | +| `input` - [`SetPaymentMethodAndPlaceOrderInput`](/reference/graphql/latest/types-q-s.md#setpaymentmethodandplaceorderinput) | | #### Example @@ -7051,13 +7051,13 @@ mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInpu Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](/reference/graphql/latest/types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](/reference/graphql/latest/types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -7091,13 +7091,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](/reference/graphql/latest/types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -7160,11 +7160,11 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -7174,8 +7174,8 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", - "total_quantity": 987.65 + "template_id": 4, + "total_quantity": 123.45 } } } @@ -7187,13 +7187,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](/reference/graphql/latest/types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](/reference/graphql/latest/types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -7227,13 +7227,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](/reference/graphql/latest/types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](/reference/graphql/latest/types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -7267,15 +7267,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](/reference/graphql/latest/types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](/reference/graphql/latest/types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](/reference/graphql/latest/types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7310,7 +7310,7 @@ mutation shareGiftRegistry( ##### Response ```json -{"data": {"shareGiftRegistry": {"is_shared": true}}} +{"data": {"shareGiftRegistry": {"is_shared": false}}} ``` @@ -7319,13 +7319,13 @@ mutation shareGiftRegistry( Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](/reference/graphql/latest/types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -7390,9 +7390,9 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "is_min_max_qty_used": 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": [ @@ -7401,7 +7401,7 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, "total_quantity": 987.65 } @@ -7415,13 +7415,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](/reference/graphql/latest/types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -7453,13 +7453,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](/reference/graphql/latest/types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -7489,13 +7489,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](/reference/graphql/latest/types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](/reference/graphql/latest/types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -7539,13 +7539,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](/reference/graphql/latest/types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](/reference/graphql/latest/types-c-e.md#companyupdateinput) | | #### Example @@ -7579,13 +7579,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](/reference/graphql/latest/types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](/reference/graphql/latest/types-c-e.md#companyroleupdateinput) | | #### Example @@ -7619,13 +7619,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](/reference/graphql/latest/types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](/reference/graphql/latest/types-c-e.md#companystructureupdateinput) | | #### Example @@ -7659,13 +7659,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](/reference/graphql/latest/types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](/reference/graphql/latest/types-c-e.md#companyteamupdateinput) | | #### Example @@ -7699,13 +7699,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](/reference/graphql/latest/types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](/reference/graphql/latest/types-c-e.md#companyuserupdateinput) | | #### Example @@ -7741,13 +7741,13 @@ mutation updateCompanyUser($input: CompanyUserUpdateInput!) { Use `updateCustomerV2` instead. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/latest/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerInput!`](types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerInput!`](/reference/graphql/latest/types-c-e.md#customerinput) | An input object that defines the customer characteristics to update. | #### Example @@ -7785,14 +7785,14 @@ Use `updateCustomerAddressV2` instead. Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/latest/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](/reference/graphql/latest/types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7855,30 +7855,30 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, "default_billing": false, - "default_shipping": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", "id": 987, "lastname": "xyz789", "middlename": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", - "uid": 4, - "vat_id": "abc123" + "suffix": "xyz789", + "telephone": "abc123", + "uid": "4", + "vat_id": "xyz789" } } } @@ -7890,14 +7890,14 @@ mutation updateCustomerAddress( Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/latest/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address. | -| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the customer address. | +| `input` - [`CustomerAddressInput`](/reference/graphql/latest/types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -7970,23 +7970,23 @@ mutation updateCustomerAddressV2( "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": false, - "default_shipping": true, + "default_billing": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "id": 987, "lastname": "abc123", "middlename": "abc123", - "postcode": "abc123", - "prefix": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["xyz789"], + "region_id": 987, + "street": ["abc123"], "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "telephone": "xyz789", + "uid": 4, + "vat_id": "xyz789" } } } @@ -7998,14 +7998,14 @@ mutation updateCustomerAddressV2( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/latest/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's password. | #### Example @@ -8048,13 +8048,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/latest/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](/reference/graphql/latest/types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -8088,14 +8088,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](/reference/graphql/latest/types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](/reference/graphql/latest/types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -8121,7 +8121,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "giftRegistry": UpdateGiftRegistryInput } ``` @@ -8142,14 +8142,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](/reference/graphql/latest/types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](/reference/graphql/latest/types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -8175,7 +8175,7 @@ mutation updateGiftRegistryItems( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "items": [UpdateGiftRegistryItemInput] } ``` @@ -8198,14 +8198,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](/reference/graphql/latest/types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](/reference/graphql/latest/types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -8254,13 +8254,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](/reference/graphql/latest/types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](/reference/graphql/latest/types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -8300,13 +8300,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](/reference/graphql/latest/types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](/reference/graphql/latest/types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -8346,14 +8346,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](/reference/graphql/latest/types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](/reference/graphql/latest/types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -8382,7 +8382,7 @@ mutation updateProductsInWishlist( ```json { - "wishlistId": 4, + "wishlistId": "4", "wishlistItems": [WishlistItemUpdateInput] } ``` @@ -8406,13 +8406,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](/reference/graphql/latest/types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -8461,8 +8461,8 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "description": "abc123", "name": "xyz789", "status": "ENABLED", - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } } } @@ -8474,14 +8474,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](/reference/graphql/latest/types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](/reference/graphql/latest/types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -8507,7 +8507,7 @@ mutation updateRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "input": UpdateRequisitionListInput } ``` @@ -8530,14 +8530,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](/reference/graphql/latest/types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](/reference/graphql/latest/types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -8588,15 +8588,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](/reference/graphql/latest/types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](/reference/graphql/latest/types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -8625,7 +8625,7 @@ mutation updateWishlist( ```json { "wishlistId": 4, - "name": "abc123", + "name": "xyz789", "visibility": "PUBLIC" } ``` @@ -8650,13 +8650,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](/reference/graphql/latest/types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](/reference/graphql/latest/types-t-z.md#validatepurchaseordersinput) | | #### Example 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 49f4b4412..90419c04c 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 @@ -20,13 +20,13 @@ For header information, refer to [GraphQL headers](https://developer.adobe.com/c Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) +**Response:** [`AttributesFormOutput!`](/reference/graphql/latest/types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](types-q-s.md#string) | Form code. | +| `formCode` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Form code. | #### Example @@ -70,14 +70,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](/reference/graphql/latest/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](/reference/graphql/latest/types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](/reference/graphql/latest/types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -130,13 +130,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) +**Response:** [`[StoreConfig]`](/reference/graphql/latest/types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -411,141 +411,141 @@ query availableStores($useCurrentGroup: Boolean) { { "absolute_footer": "xyz789", "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "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_order": "xyz789", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": false, - "base_currency_code": "abc123", - "base_link_url": "xyz789", + "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": "xyz789", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": false, - "braintree_3dsecure_specificcountry": "xyz789", + "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "abc123", "braintree_3dsecure_verify_3dsecure": false, - "braintree_ach_direct_debit_vault_active": true, + "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_applepay_vault_active": true, + "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_cvv": false, "braintree_environment": "xyz789", "braintree_googlepay_btn_color": "abc123", "braintree_googlepay_cctypes": "xyz789", "braintree_googlepay_merchant_id": "abc123", "braintree_googlepay_vault_active": false, "braintree_local_payment_allowed_methods": "xyz789", - "braintree_local_payment_fallback_button_text": "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": "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_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_layout": "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": false, + "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": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_label": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_shape": "abc123", "braintree_paypal_button_location_cart_type_paylater_show": true, - "braintree_paypal_button_location_cart_type_paypal_color": "abc123", - "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", - "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": "abc123", + "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": true, "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_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": "xyz789", + "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_shape": "abc123", "braintree_paypal_button_location_checkout_type_paylater_show": false, "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789", - "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", - "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_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_color": "abc123", + "braintree_paypal_button_location_productpage_type_credit_label": "abc123", "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789", - "braintree_paypal_button_location_productpage_type_credit_show": false, - "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_productpage_type_messaging_logo": "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": "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_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_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": "abc123", - "braintree_paypal_button_location_productpage_type_paypal_show": false, - "braintree_paypal_credit_uk_merchant_name": "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_merchant_name_override": "abc123", "braintree_paypal_require_billing_address": true, - "braintree_paypal_send_cart_line_items": false, + "braintree_paypal_send_cart_line_items": true, "braintree_paypal_vault_active": true, "cart_expires_in_days": 987, "cart_gift_wrapping": "abc123", "cart_merge_preference": "abc123", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 123, + "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_enabled": true, "check_money_order_make_check_payable_to": "abc123", "check_money_order_max_order_total": "abc123", - "check_money_order_min_order_total": "abc123", - "check_money_order_new_order_status": "xyz789", - "check_money_order_payment_from_specific_countries": "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": "abc123", - "cms_no_route": "abc123", - "code": "abc123", + "cms_no_route": "xyz789", + "code": "xyz789", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": false, + "configurable_thumbnail_source": "abc123", + "contact_enabled": true, "copyright": "xyz789", - "countries_with_required_region": "xyz789", + "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": "xyz789", - "default_title": "abc123", - "demonotice": 987, + "default_display_currency_code": "xyz789", + "default_keywords": "abc123", + "default_title": "xyz789", + "demonotice": 123, "display_product_prices_in_catalog": 123, - "display_shipping_prices": 123, - "display_state_if_optional": true, - "enable_multiple_wishlists": "xyz789", + "display_shipping_prices": 987, + "display_state_if_optional": false, + "enable_multiple_wishlists": "abc123", "fixed_product_taxes_apply_tax_to_fpt": false, "fixed_product_taxes_display_prices_in_emails": 123, "fixed_product_taxes_display_prices_in_product_lists": 123, "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": true, - "fixed_product_taxes_include_fpt_in_subtotal": true, + "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_enable": false, + "fixed_product_taxes_include_fpt_in_subtotal": false, "front": "abc123", "graphql_share_customer_group": false, "grid_per_page": 987, @@ -555,102 +555,102 @@ query availableStores($useCurrentGroup: Boolean) { "head_shortcut_icon": "abc123", "header_logo_src": "abc123", "id": 123, - "is_checkout_agreements_enabled": true, - "is_default_store": false, - "is_default_store_group": true, + "is_checkout_agreements_enabled": false, + "is_default_store": true, + "is_default_store_group": false, "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": false, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "abc123", - "list_mode": "xyz789", - "list_per_page": 987, + "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": 123, - "logo_width": 987, + "logo_width": 123, "magento_reward_general_is_enabled": "abc123", "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "abc123", - "magento_reward_general_publish_history": "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": "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_register": "abc123", "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "xyz789", + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", "max_items_in_order_summary": 123, "maximum_number_of_wishlists": "xyz789", "minicart_display": true, "minicart_max_items": 987, - "minimum_password_length": "xyz789", - "newsletter_enabled": true, - "no_route": "abc123", + "minimum_password_length": "abc123", + "newsletter_enabled": false, + "no_route": "xyz789", "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": false, + "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": 987, - "orders_invoices_credit_memos_display_zero_tax": true, + "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": "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": "xyz789", + "product_reviews_enabled": "abc123", + "product_url_suffix": "abc123", "quickorder_active": false, "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": "abc123", "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", + "secure_base_static_url": "abc123", "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, "share_active_segments": false, - "share_applied_cart_rule": false, - "shopping_cart_display_full_summary": false, + "share_applied_cart_rule": true, + "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": 123, + "shopping_cart_display_price": 123, + "shopping_cart_display_shipping": 987, + "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 987, - "store_code": 4, + "store_code": "4", "store_group_code": 4, "store_group_name": "abc123", "store_name": "abc123", "store_sort_order": 123, - "timezone": "xyz789", + "timezone": "abc123", "title_prefix": "abc123", "title_separator": "xyz789", "title_suffix": "abc123", - "use_store_in_url": true, - "website_code": "4", + "use_store_in_url": false, + "website_code": 4, "website_id": 987, - "website_name": "abc123", + "website_name": "xyz789", "weight_unit": "abc123", - "welcome": "xyz789", + "welcome": "abc123", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "xyz789", + "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_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 123, "zero_subtotal_title": "xyz789" } ] @@ -664,13 +664,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](types-c-e.md#cart) +**Response:** [`Cart`](/reference/graphql/latest/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -740,7 +740,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` ##### Response @@ -759,12 +759,12 @@ query cart($cart_id: String!) { 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, @@ -784,15 +784,15 @@ query cart($cart_id: String!) { Return a list of categories that match the specified filter. -**Response:** [`CategoryResult`](types-c-e.md#categoryresult) +**Response:** [`CategoryResult`](/reference/graphql/latest/types-c-e.md#categoryresult) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/latest/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -854,13 +854,13 @@ Use `categories` instead. Search for categories that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`CategoryTree`](types-c-e.md#categorytree) +**Response:** [`CategoryTree`](/reference/graphql/latest/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The category ID to use as the root of the search. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The category ID to use as the root of the search. | #### Example @@ -921,7 +921,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 987} +{"id": 123} ``` ##### Response @@ -935,28 +935,28 @@ query category($id: Int) { "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "xyz789", "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", + "default_sort_by": "abc123", "description": "xyz789", - "display_mode": "abc123", - "filter_price_range": 987.65, - "id": 987, - "image": "abc123", - "include_in_menu": 123, + "display_mode": "xyz789", + "filter_price_range": 123.45, + "id": 123, + "image": "xyz789", + "include_in_menu": 987, "is_anchor": 123, "landing_page": 987, "level": 987, "meta_description": "xyz789", - "meta_keywords": "abc123", + "meta_keywords": "xyz789", "meta_title": "abc123", "name": "abc123", "path": "xyz789", - "path_in_store": "xyz789", - "position": 123, - "product_count": 987, + "path_in_store": "abc123", + "position": 987, + "product_count": 123, "products": CategoryProducts, "redirect_code": 987, "relative_url": "xyz789", @@ -964,9 +964,9 @@ query category($id: Int) { "type": "CMS_PAGE", "uid": "4", "updated_at": "abc123", - "url_key": "xyz789", - "url_path": "abc123", - "url_suffix": "abc123" + "url_key": "abc123", + "url_path": "xyz789", + "url_suffix": "xyz789" } } } @@ -982,15 +982,15 @@ Use `categories` instead. Return an array of categories based on the specified filters. -**Response:** [`[CategoryTree]`](types-c-e.md#categorytree) +**Response:** [`[CategoryTree]`](/reference/graphql/latest/types-c-e.md#categorytree) #### Arguments | Name | Description | |------|-------------| -| `filters` - [`CategoryFilterInput`](types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `filters` - [`CategoryFilterInput`](/reference/graphql/latest/types-c-e.md#categoryfilterinput) | Identifies which Category filter inputs to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Specifies the maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | #### Example @@ -1073,8 +1073,8 @@ query categoryList( "data": { "categoryList": [ { - "automatic_sorting": "xyz789", - "available_sort_by": ["xyz789"], + "automatic_sorting": "abc123", + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], @@ -1082,33 +1082,33 @@ query categoryList( "cms_block": CmsBlock, "created_at": "abc123", "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", + "default_sort_by": "xyz789", "description": "xyz789", "display_mode": "abc123", - "filter_price_range": 987.65, - "id": 123, - "image": "abc123", + "filter_price_range": 123.45, + "id": 987, + "image": "xyz789", "include_in_menu": 123, - "is_anchor": 123, + "is_anchor": 987, "landing_page": 123, - "level": 123, + "level": 987, "meta_description": "abc123", - "meta_keywords": "xyz789", - "meta_title": "xyz789", + "meta_keywords": "abc123", + "meta_title": "abc123", "name": "xyz789", "path": "xyz789", - "path_in_store": "abc123", + "path_in_store": "xyz789", "position": 987, - "product_count": 123, + "product_count": 987, "products": CategoryProducts, - "redirect_code": 123, - "relative_url": "xyz789", + "redirect_code": 987, + "relative_url": "abc123", "staged": true, "type": "CMS_PAGE", - "uid": "4", - "updated_at": "xyz789", - "url_key": "xyz789", - "url_path": "abc123", + "uid": 4, + "updated_at": "abc123", + "url_key": "abc123", + "url_path": "xyz789", "url_suffix": "xyz789" } ] @@ -1122,7 +1122,7 @@ query categoryList( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](/reference/graphql/latest/types-c-e.md#checkoutagreement) #### Example @@ -1155,7 +1155,7 @@ query checkoutAgreements { "content_height": "xyz789", "is_html": false, "mode": "AUTO", - "name": "xyz789" + "name": "abc123" } ] } @@ -1168,13 +1168,13 @@ query checkoutAgreements { Return information about CMS blocks. -**Response:** [`CmsBlocks`](types-c-e.md#cmsblocks) +**Response:** [`CmsBlocks`](/reference/graphql/latest/types-c-e.md#cmsblocks) #### Arguments | Name | Description | |------|-------------| -| `identifiers` - [`[String]`](types-q-s.md#string) | An array of CMS block IDs. | +| `identifiers` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | An array of CMS block IDs. | #### Example @@ -1193,7 +1193,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["abc123"]} +{"identifiers": ["xyz789"]} ``` ##### Response @@ -1208,14 +1208,14 @@ query cmsBlocks($identifiers: [String]) { Return details about a CMS page. -**Response:** [`CmsPage`](types-c-e.md#cmspage) +**Response:** [`CmsPage`](/reference/graphql/latest/types-c-e.md#cmspage) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The ID of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The identifier of the CMS page. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID of the CMS page. | +| `identifier` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The identifier of the CMS page. | #### Example @@ -1259,17 +1259,17 @@ query cmsPage( "data": { "cmsPage": { "content": "abc123", - "content_heading": "xyz789", - "identifier": "xyz789", + "content_heading": "abc123", + "identifier": "abc123", "meta_description": "xyz789", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "abc123", "page_layout": "xyz789", "redirect_code": 123, - "relative_url": "xyz789", + "relative_url": "abc123", "title": "abc123", "type": "CMS_PAGE", - "url_key": "xyz789" + "url_key": "abc123" } } } @@ -1281,7 +1281,7 @@ query cmsPage( Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](types-c-e.md#company) +**Response:** [`Company`](/reference/graphql/latest/types-c-e.md#company) #### Example @@ -1347,11 +1347,11 @@ query company { "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "xyz789", + "email": "abc123", "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "xyz789", + "name": "abc123", "payment_methods": ["xyz789"], "reseller_id": "xyz789", "role": CompanyRole, @@ -1373,13 +1373,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/latest/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -1403,7 +1403,7 @@ query compareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -1413,7 +1413,7 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -1427,7 +1427,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](types-c-e.md#country) +**Response:** [`[Country]`](/reference/graphql/latest/types-c-e.md#country) #### Example @@ -1457,8 +1457,8 @@ query countries { { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "abc123", + "full_name_locale": "xyz789", + "id": "xyz789", "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" } @@ -1473,13 +1473,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](types-c-e.md#country) +**Response:** [`Country`](/reference/graphql/latest/types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](types-q-s.md#string) | | +| `id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -1503,7 +1503,7 @@ query country($id: String) { ##### Variables ```json -{"id": "abc123"} +{"id": "xyz789"} ``` ##### Response @@ -1514,10 +1514,10 @@ query country($id: String) { "country": { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "xyz789", + "full_name_locale": "xyz789", + "id": "abc123", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } } } @@ -1529,7 +1529,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](types-c-e.md#currency) +**Response:** [`Currency`](/reference/graphql/latest/types-c-e.md#currency) #### Example @@ -1562,11 +1562,11 @@ query currency { "abc123" ], "base_currency_code": "xyz789", - "base_currency_symbol": "abc123", - "default_display_currecy_code": "abc123", + "base_currency_symbol": "xyz789", + "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "abc123", - "default_display_currency_code": "abc123", - "default_display_currency_symbol": "abc123", + "default_display_currency_code": "xyz789", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } } @@ -1583,13 +1583,13 @@ Use `customAttributeMetadataV2` query instead. Return the attribute type, given an attribute code and entity type. -**Response:** [`CustomAttributeMetadata`](types-c-e.md#customattributemetadata) +**Response:** [`CustomAttributeMetadata`](/reference/graphql/latest/types-c-e.md#customattributemetadata) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]!`](types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | +| `attributes` - [`[AttributeInput!]!`](/reference/graphql/latest/types-a-b.md#attributeinput) | An input object that specifies the attribute code and entity type to search. | #### Example @@ -1627,13 +1627,13 @@ query customAttributeMetadata($attributes: [AttributeInput!]!) { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](/reference/graphql/latest/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](/reference/graphql/latest/types-a-b.md#attributeinput) | | #### Example @@ -1677,7 +1677,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/latest/types-c-e.md#customer) #### Example @@ -1799,16 +1799,16 @@ 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": "abc123", + "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], "date_of_birth": "abc123", "default_billing": "xyz789", - "default_shipping": "xyz789", - "dob": "abc123", + "default_shipping": "abc123", + "dob": "xyz789", "email": "abc123", "firstname": "abc123", "gender": 987, @@ -1817,10 +1817,10 @@ query customer { "group": CustomerGroupStorefront, "group_id": 987, "id": "4", - "is_subscribed": false, - "job_title": "xyz789", - "lastname": "xyz789", - "middlename": "xyz789", + "is_subscribed": true, + "job_title": "abc123", + "lastname": "abc123", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -1828,7 +1828,7 @@ query customer { "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, + "purchase_orders_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1839,10 +1839,10 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1857,7 +1857,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) #### Example @@ -1940,16 +1940,16 @@ query customerCart { 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": false, + "id": "4", + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -1965,7 +1965,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](/reference/graphql/latest/types-c-e.md#customerdownloadableproducts) #### Example @@ -1999,7 +1999,7 @@ query customerDownloadableProducts { Provides Customer Group assigned to the Customer or Guest. -**Response:** [`CustomerGroupStorefront!`](types-c-e.md#customergroupstorefront) +**Response:** [`CustomerGroupStorefront!`](/reference/graphql/latest/types-c-e.md#customergroupstorefront) #### Example @@ -2027,7 +2027,7 @@ query customerGroup { Use the `customer` query instead. -**Response:** [`CustomerOrders`](types-c-e.md#customerorders) +**Response:** [`CustomerOrders`](/reference/graphql/latest/types-c-e.md#customerorders) #### Example @@ -2069,7 +2069,7 @@ query customerOrders { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](/reference/graphql/latest/types-c-e.md#customerpaymenttokens) #### Example @@ -2101,13 +2101,13 @@ query customerPaymentTokens { Customer segments associated with the current customer or guest/visitor. -**Response:** [`[CustomerSegmentStorefront]`](types-c-e.md#customersegmentstorefront) +**Response:** [`[CustomerSegmentStorefront]`](/reference/graphql/latest/types-c-e.md#customersegmentstorefront) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `cartId` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -2130,7 +2130,11 @@ query customerSegments($cartId: String!) { ##### Response ```json -{"data": {"customerSegments": [{"uid": 4}]}} +{ + "data": { + "customerSegments": [{"uid": "4"}] + } +} ``` @@ -2139,15 +2143,15 @@ query customerSegments($cartId: String!) { Return a list of dynamic blocks filtered by type, location, or UIDs. -**Response:** [`DynamicBlocks!`](types-c-e.md#dynamicblocks) +**Response:** [`DynamicBlocks!`](/reference/graphql/latest/types-c-e.md#dynamicblocks) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DynamicBlocksFilterInput`](types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | +| `input` - [`DynamicBlocksFilterInput`](/reference/graphql/latest/types-c-e.md#dynamicblocksfilterinput) | Defines the filter for returning matching dynamic blocks. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | #### Example @@ -2205,13 +2209,13 @@ query dynamicBlocks( Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction. -**Response:** [`HostedProUrl`](types-f-i.md#hostedprourl) +**Response:** [`HostedProUrl`](/reference/graphql/latest/types-f-i.md#hostedprourl) #### Arguments | Name | Description | |------|-------------| -| `input` - [`HostedProUrlInput!`](types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | +| `input` - [`HostedProUrlInput!`](/reference/graphql/latest/types-f-i.md#hostedprourlinput) | An input object that specifies the cart ID. | #### Example @@ -2249,13 +2253,13 @@ query getHostedProUrl($input: HostedProUrlInput!) { Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods. -**Response:** [`PayflowLinkToken`](types-k-p.md#payflowlinktoken) +**Response:** [`PayflowLinkToken`](/reference/graphql/latest/types-k-p.md#payflowlinktoken) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PayflowLinkTokenInput!`](types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | +| `input` - [`PayflowLinkTokenInput!`](/reference/graphql/latest/types-k-p.md#payflowlinktokeninput) | An input object that defines the requirements to receive a payment token. | #### Example @@ -2285,9 +2289,9 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "abc123", + "paypal_url": "xyz789", "secure_token": "xyz789", - "secure_token_id": "xyz789" + "secure_token_id": "abc123" } } } @@ -2299,13 +2303,13 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](/reference/graphql/latest/types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/latest/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2361,14 +2365,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](/reference/graphql/latest/types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | +| `cartId` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | #### Example @@ -2408,10 +2412,10 @@ query getPaymentOrder( { "data": { "getPaymentOrder": { - "id": "abc123", + "id": "xyz789", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "status": "abc123" } } } @@ -2423,13 +2427,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](/reference/graphql/latest/types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/latest/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -2467,7 +2471,7 @@ query getPaymentSDK($location: PaymentLocation!) { Retrieves the vault configuration -**Response:** [`VaultConfigOutput`](types-t-z.md#vaultconfigoutput) +**Response:** [`VaultConfigOutput`](/reference/graphql/latest/types-t-z.md#vaultconfigoutput) #### Example @@ -2501,13 +2505,13 @@ query getVaultConfig { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/latest/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/latest/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -2539,7 +2543,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } } } @@ -2551,13 +2555,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) +**Response:** [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -2595,7 +2599,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -2604,20 +2608,20 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "xyz789", + "message": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } } } @@ -2629,13 +2633,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/latest/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The registrant's email. | #### Example @@ -2657,7 +2661,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2668,11 +2672,11 @@ query giftRegistryEmailSearch($email: String!) { "giftRegistryEmailSearch": [ { "event_date": "abc123", - "event_title": "xyz789", + "event_title": "abc123", "gift_registry_uid": "4", - "location": "xyz789", - "name": "xyz789", - "type": "abc123" + "location": "abc123", + "name": "abc123", + "type": "xyz789" } ] } @@ -2685,13 +2689,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/latest/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -2725,8 +2729,8 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { { "event_date": "abc123", "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "xyz789", + "gift_registry_uid": 4, + "location": "abc123", "name": "xyz789", "type": "xyz789" } @@ -2741,15 +2745,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/latest/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | +| `firstName` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2780,7 +2784,7 @@ query giftRegistryTypeSearch( ```json { - "firstName": "abc123", + "firstName": "xyz789", "lastName": "xyz789", "giftRegistryTypeUid": "4" } @@ -2794,11 +2798,11 @@ query giftRegistryTypeSearch( "giftRegistryTypeSearch": [ { "event_date": "abc123", - "event_title": "xyz789", + "event_title": "abc123", "gift_registry_uid": 4, - "location": "abc123", + "location": "xyz789", "name": "xyz789", - "type": "xyz789" + "type": "abc123" } ] } @@ -2811,7 +2815,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) +**Response:** [`[GiftRegistryType]`](/reference/graphql/latest/types-f-i.md#giftregistrytype) #### Example @@ -2839,8 +2843,8 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "abc123", - "uid": 4 + "label": "xyz789", + "uid": "4" } ] } @@ -2853,13 +2857,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and billing last name. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/latest/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderInformationInput!`](types-f-i.md#guestorderinformationinput) | | +| `input` - [`GuestOrderInformationInput!`](/reference/graphql/latest/types-f-i.md#guestorderinformationinput) | | #### Example @@ -2953,7 +2957,7 @@ query guestOrder($input: GuestOrderInformationInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "created_at": "abc123", "credit_memos": [CreditMemo], @@ -2962,25 +2966,25 @@ query guestOrder($input: GuestOrderInformationInput!) { "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": 4, - "increment_id": "abc123", + "grand_total": 987.65, + "id": "4", + "increment_id": "xyz789", "invoices": [Invoice], "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", - "order_date": "xyz789", - "order_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": "xyz789", - "status": "abc123", - "token": "abc123", + "shipping_method": "abc123", + "status": "xyz789", + "token": "xyz789", "total": OrderTotal } } @@ -2993,13 +2997,13 @@ query guestOrder($input: GuestOrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/latest/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](/reference/graphql/latest/types-k-p.md#ordertokeninput) | | #### Example @@ -3093,34 +3097,34 @@ 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", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "grand_total": 987.65, - "id": 4, + "id": "4", "increment_id": "abc123", "invoices": [Invoice], "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", + "number": "xyz789", "order_date": "xyz789", - "order_number": "abc123", + "order_number": "xyz789", "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": "abc123", - "token": "abc123", + "shipping_method": "xyz789", + "status": "xyz789", + "token": "xyz789", "total": OrderTotal } } @@ -3133,13 +3137,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](/reference/graphql/latest/types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -3162,7 +3166,7 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} ``` @@ -3171,13 +3175,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](/reference/graphql/latest/types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -3194,7 +3198,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -3209,13 +3213,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](/reference/graphql/latest/types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](types-q-s.md#string) | | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -3232,13 +3236,13 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "xyz789"} +{"name": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} ``` @@ -3247,13 +3251,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](/reference/graphql/latest/types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -3270,7 +3274,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -3285,13 +3289,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](/reference/graphql/latest/types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to check. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address to check. | #### Example @@ -3308,13 +3312,13 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": false}}} +{"data": {"isEmailAvailable": {"is_email_available": true}}} ``` @@ -3323,13 +3327,13 @@ query isEmailAvailable($email: String!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) +**Response:** [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -3380,7 +3384,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -3395,21 +3399,21 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "email": "xyz789", + "created_at": "xyz789", + "email": "abc123", "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, - "updated_at": "abc123" + "total_quantity": 987.65, + "uid": "4", + "updated_at": "xyz789" } } } @@ -3421,13 +3425,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](types-f-i.md#id) | | +| `templateId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | | #### Example @@ -3489,11 +3493,11 @@ 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": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -3505,7 +3509,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ], "status": "abc123", "template_id": "4", - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -3517,16 +3521,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -3591,16 +3595,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](/reference/graphql/latest/types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](/reference/graphql/latest/types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](/reference/graphql/latest/types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3665,18 +3669,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) +**Response:** [`PickupLocations`](/reference/graphql/latest/types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](/reference/graphql/latest/types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](/reference/graphql/latest/types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](/reference/graphql/latest/types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](/reference/graphql/latest/types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3743,7 +3747,7 @@ query pickupLocations( Return the active ratings attributes and the values each rating can have. -**Response:** [`ProductReviewRatingsMetadata!`](types-k-p.md#productreviewratingsmetadata) +**Response:** [`ProductReviewRatingsMetadata!`](/reference/graphql/latest/types-k-p.md#productreviewratingsmetadata) #### Example @@ -3777,17 +3781,17 @@ query productReviewRatingsMetadata { Search for products that match the criteria specified in the `search` and `filter` attributes. -**Response:** [`Products`](types-k-p.md#products) +**Response:** [`Products`](/reference/graphql/latest/types-k-p.md#products) #### Arguments | Name | Description | |------|-------------| -| `search` - [`String`](types-q-s.md#string) | One or more keywords to use in a full-text search. | -| `filter` - [`ProductAttributeFilterInput`](types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`ProductAttributeSortInput`](types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | +| `search` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One or more keywords to use in a full-text search. | +| `filter` - [`ProductAttributeFilterInput`](/reference/graphql/latest/types-k-p.md#productattributefilterinput) | The product attributes to search for and return. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`ProductAttributeSortInput`](/reference/graphql/latest/types-k-p.md#productattributesortinput) | Specifies which attributes to sort on, and whether to return the results in ascending or descending order. | #### Example @@ -3865,13 +3869,13 @@ query products( ### recaptchaFormConfig -**Response:** [`ReCaptchaConfigOutput`](types-q-s.md#recaptchaconfigoutput) +**Response:** [`ReCaptchaConfigOutput`](/reference/graphql/latest/types-q-s.md#recaptchaconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `formType` - [`ReCaptchaFormEnum!`](types-q-s.md#recaptchaformenum) | | +| `formType` - [`ReCaptchaFormEnum!`](/reference/graphql/latest/types-q-s.md#recaptchaformenum) | | #### Example @@ -3901,7 +3905,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } } } @@ -3913,7 +3917,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](/reference/graphql/latest/types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3941,12 +3945,12 @@ query recaptchaV3Config { "data": { "recaptchaV3Config": { "badge_position": "xyz789", - "failure_message": "xyz789", + "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": false, + "is_enabled": true, "language_code": "abc123", "minimum_score": 987.65, - "theme": "abc123", + "theme": "xyz789", "website_key": "abc123" } } @@ -3959,13 +3963,13 @@ query recaptchaV3Config { Return the full details for a specified product, category, or CMS page. -**Response:** [`RoutableInterface`](types-q-s.md#routableinterface) +**Response:** [`RoutableInterface`](/reference/graphql/latest/types-q-s.md#routableinterface) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3984,7 +3988,7 @@ query route($url: String!) { ##### Variables ```json -{"url": "abc123"} +{"url": "xyz789"} ``` ##### Response @@ -3994,7 +3998,7 @@ query route($url: String!) { "data": { "route": { "redirect_code": 987, - "relative_url": "abc123", + "relative_url": "xyz789", "type": "CMS_PAGE" } } @@ -4007,7 +4011,7 @@ query route($url: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](types-q-s.md#storeconfig) +**Response:** [`StoreConfig`](/reference/graphql/latest/types-q-s.md#storeconfig) #### Example @@ -4280,117 +4284,117 @@ query storeConfig { "allow_guests_to_write_product_reviews": "abc123", "allow_items": "abc123", "allow_order": "xyz789", - "allow_printed_card": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_link_url": "xyz789", "base_media_url": "xyz789", - "base_static_url": "xyz789", - "base_url": "abc123", + "base_static_url": "abc123", + "base_url": "xyz789", "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": false, + "braintree_3dsecure_always_request_3ds": true, "braintree_3dsecure_specificcountry": "xyz789", - "braintree_3dsecure_threshold_amount": "xyz789", - "braintree_3dsecure_verify_3dsecure": true, - "braintree_ach_direct_debit_vault_active": false, - "braintree_applepay_merchant_name": "xyz789", + "braintree_3dsecure_threshold_amount": "abc123", + "braintree_3dsecure_verify_3dsecure": false, + "braintree_ach_direct_debit_vault_active": true, + "braintree_applepay_merchant_name": "abc123", "braintree_applepay_vault_active": false, - "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_active": "abc123", "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_merchant_id": "abc123", "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "xyz789", - "braintree_local_payment_fallback_button_text": "xyz789", - "braintree_local_payment_redirect_on_fail": "xyz789", - "braintree_merchant_account_id": "xyz789", - "braintree_paypal_button_location_cart_type_credit_color": "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_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": "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": "abc123", "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123", "braintree_paypal_button_location_cart_type_messaging_show": true, "braintree_paypal_button_location_cart_type_messaging_text_color": "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_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": false, + "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_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_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": true, + "braintree_paypal_button_location_checkout_type_credit_show": false, "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", - "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_show": true, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", + "braintree_paypal_button_location_checkout_type_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": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_label": "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_paypal_label": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", + "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", + "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123", "braintree_paypal_button_location_checkout_type_paypal_show": false, - "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_color": "abc123", "braintree_paypal_button_location_productpage_type_credit_label": "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": "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_show": true, "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789", + "braintree_paypal_button_location_productpage_type_paylater_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": "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_shape": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_show": true, + "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789", + "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789", + "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123", "braintree_paypal_button_location_productpage_type_paypal_show": true, - "braintree_paypal_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": "abc123", "braintree_paypal_merchant_name_override": "xyz789", "braintree_paypal_require_billing_address": false, "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": true, - "cart_expires_in_days": 123, + "braintree_paypal_vault_active": false, + "cart_expires_in_days": 987, "cart_gift_wrapping": "abc123", "cart_merge_preference": "xyz789", - "cart_printed_card": "xyz789", + "cart_printed_card": "abc123", "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "abc123", + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", + "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": true, - "check_money_order_enabled": true, - "check_money_order_make_check_payable_to": "xyz789", + "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": "xyz789", - "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_min_order_total": "xyz789", + "check_money_order_new_order_status": "abc123", + "check_money_order_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "abc123", "check_money_order_sort_order": 123, - "check_money_order_title": "xyz789", + "check_money_order_title": "abc123", "cms_home_page": "xyz789", "cms_no_cookies": "abc123", "cms_no_route": "abc123", "code": "abc123", "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "abc123", - "contact_enabled": true, + "contact_enabled": false, "copyright": "xyz789", - "countries_with_required_region": "xyz789", + "countries_with_required_region": "abc123", "create_account_confirmation": false, "customer_access_token_lifetime": 987.65, "default_country": "abc123", @@ -4399,121 +4403,121 @@ query storeConfig { "default_keywords": "xyz789", "default_title": "xyz789", "demonotice": 123, - "display_product_prices_in_catalog": 987, - "display_shipping_prices": 987, - "display_state_if_optional": false, - "enable_multiple_wishlists": "abc123", + "display_product_prices_in_catalog": 123, + "display_shipping_prices": 123, + "display_state_if_optional": true, + "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": true, - "fixed_product_taxes_display_prices_in_emails": 987, + "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", + "front": "abc123", "graphql_share_customer_group": false, "grid_per_page": 987, - "grid_per_page_values": "xyz789", + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "head_includes": "xyz789", - "head_shortcut_icon": "xyz789", + "head_includes": "abc123", + "head_shortcut_icon": "abc123", "header_logo_src": "abc123", - "id": 987, + "id": 123, "is_checkout_agreements_enabled": true, - "is_default_store": false, + "is_default_store": true, "is_default_store_group": true, - "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": 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": 123, + "list_mode": "abc123", + "list_per_page": 987, "list_per_page_values": "abc123", "locale": "xyz789", "logo_alt": "abc123", - "logo_height": 987, + "logo_height": 123, "logo_width": 123, - "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "abc123", - "magento_reward_general_min_points_balance": "abc123", + "magento_reward_general_min_points_balance": "xyz789", "magento_reward_general_publish_history": "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": "xyz789", - "magento_reward_points_register": "abc123", + "magento_reward_points_register": "xyz789", "magento_reward_points_review": "xyz789", - "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": true, - "minicart_max_items": 123, - "minimum_password_length": "xyz789", - "newsletter_enabled": false, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, + "minicart_max_items": 987, + "minimum_password_length": "abc123", + "newsletter_enabled": true, "no_route": "abc123", "optional_zip_countries": "xyz789", "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": false, - "orders_invoices_credit_memos_display_grandtotal": 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": 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", "quickorder_active": true, - "required_character_classes_number": "abc123", + "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": "abc123", "sales_printed_card": "xyz789", "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "share_active_segments": false, - "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_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": 123, - "store_code": 4, + "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": "abc123", - "title_prefix": "abc123", - "title_separator": "xyz789", - "title_suffix": "xyz789", - "use_store_in_url": false, - "website_code": "4", - "website_id": 123, + "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": "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": "xyz789", + "zero_subtotal_new_order_status": "abc123", + "zero_subtotal_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "xyz789" + "zero_subtotal_title": "abc123" } } } @@ -4529,13 +4533,13 @@ Use the `route` query instead. Return the relative URL for a specified product, category or CMS page. -**Response:** [`EntityUrl`](types-c-e.md#entityurl) +**Response:** [`EntityUrl`](/reference/graphql/latest/types-c-e.md#entityurl) #### Arguments | Name | Description | |------|-------------| -| `url` - [`String!`](types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4566,11 +4570,11 @@ query urlResolver($url: String!) { { "data": { "urlResolver": { - "canonical_url": "abc123", - "entity_uid": "4", - "id": 987, - "redirectCode": 123, - "relative_url": "xyz789", + "canonical_url": "xyz789", + "entity_uid": 4, + "id": 123, + "redirectCode": 987, + "relative_url": "abc123", "type": "CMS_PAGE" } } @@ -4587,7 +4591,7 @@ Moved under `Customer.wishlist`. Return the contents of a customer's wish list. -**Response:** [`WishlistOutput`](types-t-z.md#wishlistoutput) +**Response:** [`WishlistOutput`](/reference/graphql/latest/types-t-z.md#wishlistoutput) #### Example @@ -4614,9 +4618,9 @@ query wishlist { "data": { "wishlist": { "items": [WishlistItem], - "items_count": 123, + "items_count": 987, "name": "abc123", - "sharing_code": "abc123", + "sharing_code": "xyz789", "updated_at": "abc123" } } 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 index f9cccf6b7..2461a166b 100644 --- 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 @@ -8,7 +8,7 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -26,7 +26,7 @@ Defines the bundle products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The ID of the cart. | | `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | #### Example @@ -48,7 +48,7 @@ Contains details about the cart after adding bundle products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -66,14 +66,14 @@ Defines the configurable products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](/reference/graphql/latest/types-c-e.md#configurableproductcartiteminput) | An array of configurable products to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [ConfigurableProductCartItemInput] } ``` @@ -88,7 +88,7 @@ Contains details about the cart after adding configurable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -104,8 +104,8 @@ Contains details about the cart after adding configurable products. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](/reference/graphql/latest/types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example @@ -126,7 +126,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -144,10 +144,10 @@ Defines a new registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/latest/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the registrant. | #### Example @@ -157,8 +157,8 @@ Defines a new registrant. GiftRegistryDynamicAttributeInput ], "email": "xyz789", - "firstname": "abc123", - "lastname": "xyz789" + "firstname": "xyz789", + "lastname": "abc123" } ``` @@ -172,7 +172,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -190,8 +190,8 @@ Contains details about the cart after adding products to it. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | -| `user_errors` - [`[Error]!`](types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](/reference/graphql/latest/types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | #### Example @@ -212,13 +212,13 @@ Contains products to add to an existing compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": ["4"], "uid": 4} +{"products": [4], "uid": 4} ``` @@ -231,8 +231,8 @@ Contains details about the cart after adding products to it. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](types-c-e.md#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `cart` - [`Cart`](/reference/graphql/latest/types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]`](/reference/graphql/latest/types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -253,7 +253,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -271,8 +271,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/latest/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -293,8 +293,8 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a purchase order. | #### Example @@ -315,7 +315,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](/reference/graphql/latest/types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -333,8 +333,8 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example @@ -343,7 +343,7 @@ Defines the purchase order and cart to act on. { "cart_id": "xyz789", "purchase_order_uid": 4, - "replace_existing_cart_items": false + "replace_existing_cart_items": true } ``` @@ -357,14 +357,14 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A description of the error. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "type": "OUT_OF_STOCK" } ``` @@ -399,7 +399,7 @@ Output of the request to add items in a requisition list to the cart. | 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`](types-c-e.md#cart) | The cart after adding requisition list items. | +| `cart` - [`Cart`](/reference/graphql/latest/types-c-e.md#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 @@ -410,7 +410,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } ``` @@ -424,8 +424,8 @@ Defines a return comment. | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `comment_text` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -446,7 +446,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | The modified return. | +| `return` - [`Return`](/reference/graphql/latest/types-q-s.md#return) | The modified return. | #### Example @@ -464,17 +464,17 @@ Defines tracking information to be added to the return. | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | +| `carrier_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { - "carrier_uid": "4", + "carrier_uid": 4, "return_uid": "4", - "tracking_number": "xyz789" + "tracking_number": "abc123" } ``` @@ -488,8 +488,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](/reference/graphql/latest/types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](/reference/graphql/latest/types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -510,14 +510,14 @@ Defines the simple and group products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](/reference/graphql/latest/types-q-s.md#simpleproductcartiteminput) | An array of simple and group items to add. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [SimpleProductCartItemInput] } ``` @@ -532,7 +532,7 @@ Contains details about the cart after adding simple or group products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -550,8 +550,8 @@ Defines the virtual products to add to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](/reference/graphql/latest/types-t-z.md#virtualproductcartiteminput) | An array of virtual products to add. | #### Example @@ -572,7 +572,7 @@ Contains details about the cart after adding virtual products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -590,9 +590,9 @@ Contains the resultant wish list and any error information. | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](/reference/graphql/latest/types-t-z.md#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!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -616,11 +616,11 @@ Contains information for each filterable option (such as price, category `UID`, | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](types-f-i.md#int) | The number of options in the aggregation group. | -| `label` - [`String`](types-q-s.md#string) | The aggregation display name. | +| `attribute_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of options in the aggregation group. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The aggregation display name. | | `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The relative position of the attribute in a layered navigation block. | #### Example @@ -628,7 +628,7 @@ Contains information for each filterable option (such as price, category `UID`, { "attribute_code": "xyz789", "count": 123, - "label": "xyz789", + "label": "abc123", "options": [AggregationOption], "position": 123 } @@ -644,15 +644,15 @@ An implementation of `AggregationOptionInterface`. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Example ```json { - "count": 123, + "count": 987, "label": "abc123", "value": "abc123" } @@ -668,9 +668,9 @@ Defines aggregation option fields. | Field Name | Description | |------------|-------------| -| `count` - [`Int`](types-f-i.md#int) | The number of items that match the aggregation option. | -| `label` - [`String`](types-q-s.md#string) | The display label for an aggregation option. | -| `value` - [`String!`](types-q-s.md#string) | The internal ID that represents the value of the option. | +| `count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of items that match the aggregation option. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display label for an aggregation option. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The internal ID that represents the value of the option. | #### Possible Types @@ -683,7 +683,7 @@ Defines aggregation option fields. ```json { "count": 987, - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -733,13 +733,13 @@ An input object that specifies the filters used in product aggregations. | Field Name | Description | |------------|-------------| | `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `payment_intent` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/latest/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -747,12 +747,12 @@ An input object that specifies the filters used in product aggregations. { "button_styles": ButtonStyles, "code": "xyz789", - "is_visible": false, + "is_visible": true, "payment_intent": "abc123", - "payment_source": "xyz789", + "payment_source": "abc123", "sdk_params": [SDKParams], "sort_order": "abc123", - "title": "xyz789" + "title": "abc123" } ``` @@ -766,16 +766,16 @@ Apple Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | #### Example ```json { "payment_source": "xyz789", - "payments_order_id": "abc123", + "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } ``` @@ -790,12 +790,12 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example ```json -{"code": "xyz789"} +{"code": "abc123"} ``` @@ -808,19 +808,19 @@ Contains an applied gift card with applied and remaining balance. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `applied_balance` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "applied_balance": Money, - "code": "abc123", + "code": "xyz789", "current_balance": Money, - "expiration_date": "xyz789" + "expiration_date": "abc123" } ``` @@ -834,8 +834,8 @@ Contains the applied and current balances. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](types-k-p.md#money) | The current balance remaining on store credit. | +| `applied_balance` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](/reference/graphql/latest/types-k-p.md#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 @@ -844,7 +844,7 @@ Contains the applied and current balances. { "applied_balance": Money, "current_balance": Money, - "enabled": true + "enabled": false } ``` @@ -858,15 +858,15 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A valid coupon code. | #### Example ```json { - "cart_id": "xyz789", - "coupon_code": "abc123" + "cart_id": "abc123", + "coupon_code": "xyz789" } ``` @@ -880,7 +880,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -917,8 +917,8 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](types-q-s.md#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](/reference/graphql/latest/types-q-s.md#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 @@ -926,7 +926,7 @@ Apply coupons to the cart. ```json { "cart_id": "xyz789", - "coupon_codes": ["xyz789"], + "coupon_codes": ["abc123"], "type": "APPEND" } ``` @@ -941,15 +941,15 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example ```json { "cart_id": "xyz789", - "gift_card_code": "xyz789" + "gift_card_code": "abc123" } ``` @@ -963,7 +963,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -981,15 +981,15 @@ Contains applied gift cards with gift card code and amount. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](types-k-p.md#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](types-q-s.md#string) | The gift card account code. | +| `applied_balance` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The gift card account code. | #### Example ```json { "applied_balance": Money, - "code": "abc123" + "code": "xyz789" } ``` @@ -1003,7 +1003,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -1021,7 +1021,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -1039,7 +1039,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -1057,13 +1057,13 @@ AreaInput defines the parameters which will be used for filter by specified loca | Input Field | Description | |-------------|-------------| -| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | -| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| `radius` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example ```json -{"radius": 987, "search_term": "abc123"} +{"radius": 987, "search_term": "xyz789"} ``` @@ -1076,13 +1076,13 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](/reference/graphql/latest/types-c-e.md#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} +{"compare_list": CompareList, "result": false} ``` @@ -1095,20 +1095,20 @@ Contains details about the attribute, including the code and type. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_code` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The data type of the attribute. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](types-q-s.md#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `attribute_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The data type of the attribute. | +| `entity_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](/reference/graphql/latest/types-q-s.md#storefrontproperties) | Details about the storefront properties configured for the attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "attribute_options": [AttributeOption], - "attribute_type": "xyz789", + "attribute_type": "abc123", "entity_type": "xyz789", "input_type": "xyz789", "storefront_properties": StorefrontProperties @@ -1166,16 +1166,16 @@ An input object that specifies the filters used for attributes. { "is_comparable": true, "is_filterable": true, - "is_filterable_in_search": false, - "is_html_allowed_on_front": true, - "is_searchable": 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": true, + "is_used_for_price_rules": false, "is_used_for_promo_rules": true, "is_visible_in_advanced_search": true, - "is_visible_on_front": false, - "is_wysiwyg_enabled": true, - "used_in_product_listing": true + "is_visible_on_front": true, + "is_wysiwyg_enabled": false, + "used_in_product_listing": false } ``` @@ -1222,14 +1222,14 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `attribute_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of entity that defines the attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "entity_type": "xyz789" } ``` @@ -1244,12 +1244,12 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute option value. | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -1262,15 +1262,15 @@ Base EAV implementation of CustomAttributeMetadataInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Default attribute value. | | `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_class` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/latest/types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example @@ -1281,9 +1281,9 @@ Base EAV implementation of CustomAttributeMetadataInterface. "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_required": true, - "is_unique": true, - "label": "xyz789", + "is_required": false, + "is_unique": false, + "label": "abc123", "options": [CustomAttributeOptionInterface] } ``` @@ -1298,7 +1298,7 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example @@ -1341,15 +1341,15 @@ Defines an attribute option. | Field Name | Description | |------------|-------------| -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The attribute option value. | #### Example ```json { - "label": "xyz789", - "value": "abc123" + "label": "abc123", + "value": "xyz789" } ``` @@ -1364,15 +1364,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| | `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute option value. | #### Example ```json { - "is_default": true, - "label": "xyz789", + "is_default": false, + "label": "abc123", "value": "xyz789" } ``` @@ -1385,15 +1385,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute selected option value. | #### Example ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -1405,8 +1405,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1431,14 +1431,14 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example ```json { - "code": "4", + "code": 4, "selected_options": [AttributeSelectedOptionInterface] } ``` @@ -1451,8 +1451,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The attribute value. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute value. | #### Example @@ -1470,9 +1470,9 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The code of the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The code of the attribute. | | `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value assigned to the attribute. | #### Example @@ -1480,7 +1480,7 @@ Specifies the value for attribute. { "attribute_code": "abc123", "selected_options": [AttributeInputSelectedOption], - "value": "xyz789" + "value": "abc123" } ``` @@ -1492,7 +1492,7 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1500,12 +1500,12 @@ Specifies the value for attribute. |----------------| | [`AttributeValue`](#attributevalue) | | [`AttributeSelectedOptions`](#attributeselectedoptions) | -| [`GiftCartAttributeValue`](types-f-i.md#giftcartattributevalue) | +| [`GiftCartAttributeValue`](/reference/graphql/latest/types-f-i.md#giftcartattributevalue) | #### Example ```json -{"code": "4"} +{"code": 4} ``` @@ -1519,7 +1519,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/latest/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1541,7 +1541,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/latest/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1562,13 +1562,13 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](/reference/graphql/latest/types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Currency symbol, for example $. | #### Example ```json -{"code": "AFN", "symbol": "xyz789"} +{"code": "AFN", "symbol": "abc123"} ``` @@ -1581,16 +1581,16 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](types-q-s.md#string) | The payment method title. | +| `title` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The payment method title. | #### Example ```json { "code": "xyz789", - "is_deferred": false, + "is_deferred": true, "title": "xyz789" } ``` @@ -1605,28 +1605,28 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#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`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | -| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | -| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `base_amount` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example ```json { "amount": Money, - "available": true, + "available": false, "base_amount": Money, "carrier_code": "abc123", - "carrier_title": "xyz789", + "carrier_title": "abc123", "error_message": "xyz789", - "method_code": "abc123", + "method_code": "xyz789", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -1661,9 +1661,9 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `address` - [`CartAddressInput`](/reference/graphql/latest/types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#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. | @@ -1672,9 +1672,9 @@ Defines the billing address. ```json { "address": CartAddressInput, - "customer_address_id": 987, + "customer_address_id": 123, "customer_address_uid": "4", - "same_as_shipping": false, + "same_as_shipping": true, "use_for_shipping": true } ``` @@ -1689,23 +1689,23 @@ The billing address information | Input Field | Description | |-------------|-------------| -| `address_line_1` - [`String`](types-q-s.md#string) | The first line of the address | -| `address_line_2` - [`String`](types-q-s.md#string) | The second line of the address | -| `city` - [`String`](types-q-s.md#string) | The city of the address | -| `country_code` - [`String!`](types-q-s.md#string) | The country of the address | -| `postal_code` - [`String`](types-q-s.md#string) | The postal code of the address | -| `region` - [`String`](types-q-s.md#string) | The region of the address | +| `address_line_1` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The first line of the address | +| `address_line_2` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The second line of the address | +| `city` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The city of the address | +| `country_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The country of the address | +| `postal_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The postal code of the address | +| `region` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The region of the address | #### Example ```json { - "address_line_1": "abc123", + "address_line_1": "xyz789", "address_line_2": "xyz789", - "city": "abc123", + "city": "xyz789", "country_code": "abc123", "postal_code": "xyz789", - "region": "xyz789" + "region": "abc123" } ``` @@ -1719,49 +1719,49 @@ Contains details about the billing address. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/latest/types-c-e.md#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`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `customer_notes` - [`String`](types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `customer_notes` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](/reference/graphql/latest/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, "customer_notes": "abc123", - "fax": "xyz789", + "fax": "abc123", "firstname": "abc123", "id": 123, "lastname": "xyz789", "middlename": "xyz789", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "abc123", "region": CartAddressRegion, "street": ["xyz789"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, - "vat_id": "xyz789" + "telephone": "abc123", + "uid": "4", + "vat_id": "abc123" } ``` @@ -1771,6 +1771,12 @@ Contains details about the billing address. The `Boolean` scalar type represents `true` or `false`. +#### Example + +```json +true +``` + ### BraintreeCcVaultInput @@ -1779,15 +1785,15 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | | -| `public_hash` - [`String!`](types-q-s.md#string) | | +| `device_data` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `public_hash` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example ```json { "device_data": "xyz789", - "public_hash": "abc123" + "public_hash": "xyz789" } ``` @@ -1799,16 +1805,16 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway. | +| `device_data` - [`String`](/reference/graphql/latest/types-q-s.md#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!`](types-q-s.md#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | +| `payment_method_nonce` - [`String!`](/reference/graphql/latest/types-q-s.md#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": true, + "is_active_payment_token_enabler": false, "payment_method_nonce": "xyz789" } ``` @@ -1821,14 +1827,14 @@ The `Boolean` scalar type represents `true` or `false`. | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](types-q-s.md#string) | | -| `public_hash` - [`String!`](types-q-s.md#string) | | +| `device_data` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `public_hash` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example ```json { - "device_data": "xyz789", + "device_data": "abc123", "public_hash": "xyz789" } ``` @@ -1843,12 +1849,12 @@ Contains details about an individual category that comprises a breadcrumb. | Field Name | Description | |------------|-------------| -| `category_id` - [`Int`](types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](types-f-i.md#int) | The category level. | -| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | -| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | +| `category_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The category level. | +| `category_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL path of the category. | #### Example @@ -1857,7 +1863,7 @@ Contains details about an individual category that comprises a breadcrumb. "category_id": 123, "category_level": 123, "category_name": "abc123", - "category_uid": 4, + "category_uid": "4", "category_url_key": "abc123", "category_url_path": "abc123" } @@ -1873,24 +1879,24 @@ An implementation for bundle product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/latest/types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/latest/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | | `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/latest/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1903,11 +1909,11 @@ An implementation for bundle product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", - "is_available": true, - "max_qty": 987.65, - "min_qty": 123.45, - "not_available_message": "abc123", + "id": "abc123", + "is_available": false, + "max_qty": 123.45, + "min_qty": 987.65, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -1927,14 +1933,14 @@ Defines bundle product options for `CreditMemoItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/latest/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | #### Example @@ -1942,12 +1948,12 @@ Defines bundle product options for `CreditMemoItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 } ``` @@ -1961,14 +1967,14 @@ Defines bundle product options for `InvoiceItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/latest/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1976,12 +1982,12 @@ Defines bundle product options for `InvoiceItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 + "product_sku": "xyz789", + "quantity_invoiced": 123.45 } ``` @@ -1995,15 +2001,15 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | | `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | -| `title` - [`String`](types-q-s.md#string) | The display name of the item. | -| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example @@ -2013,10 +2019,10 @@ Defines an individual item within a bundle product. "options": [BundleItemOption], "position": 123, "price_range": PriceRange, - "required": true, + "required": false, "sku": "abc123", "title": "abc123", - "type": "xyz789", + "type": "abc123", "uid": "4" } ``` @@ -2032,26 +2038,26 @@ Defines the characteristics that comprise a specific bundle item and its options | Field Name | Description | |------------|-------------| | `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](types-f-i.md#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example ```json { - "can_change_quantity": false, - "id": 123, + "can_change_quantity": true, + "id": 987, "is_default": true, - "label": "xyz789", - "position": 987, + "label": "abc123", + "position": 123, "price": 987.65, "price_type": "FIXED", "product": ProductInterface, @@ -2071,17 +2077,17 @@ Defines the input for a bundle option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](types-q-s.md#string) | An array with the chosen value of the option. | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The ID of the option. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array with the chosen value of the option. | #### Example ```json { - "id": 123, + "id": 987, "quantity": 987.65, - "value": ["xyz789"] + "value": ["abc123"] } ``` @@ -2095,30 +2101,30 @@ Defines bundle product options for `OrderItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/latest/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#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]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/latest/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the order item. | #### Example @@ -2126,25 +2132,25 @@ Defines bundle product options for `OrderItemInterface`. { "bundle_options": [ItemSelectedBundleOption], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "abc123", + "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "xyz789", - "quantity_canceled": 123.45, + "quantity_canceled": 987.65, "quantity_invoiced": 123.45, "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, + "quantity_refunded": 123.45, + "quantity_return_requested": 987.65, + "quantity_returned": 123.45, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" @@ -2161,95 +2167,95 @@ Defines basic features of a bundle product and contains multiple BundleItems. | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `attribute_set_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](/reference/graphql/latest/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/latest/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#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`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Indicates whether the product can be returned. | | `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `manufacturer` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/latest/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/latest/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/latest/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/latest/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](/reference/graphql/latest/types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/latest/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](/reference/graphql/latest/types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/latest/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | The list of products reviews. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](/reference/graphql/latest/types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/latest/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/latest/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/latest/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { "attribute_set_id": 123, - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], "color": 123, "country_of_manufacture": "abc123", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "dynamic_price": true, "dynamic_sku": false, - "dynamic_weight": false, - "gift_message_available": false, - "gift_wrapping_available": false, + "dynamic_weight": true, + "gift_message_available": true, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "id": 123, "image": ProductImage, @@ -2259,16 +2265,16 @@ Defines basic features of a bundle product and contains multiple BundleItems. "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 123.45, + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price": ProductPrices, "price_details": PriceDetails, "price_range": PriceRange, @@ -2279,25 +2285,25 @@ Defines basic features of a bundle product and contains multiple BundleItems. "rating_summary": 123.45, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, + "relative_url": "abc123", + "review_count": 987, "reviews": ProductReviews, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "abc123", + "special_from_date": "xyz789", "special_price": 123.45, - "special_to_date": "abc123", + "special_to_date": "xyz789", "staged": false, "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", - "uid": 4, + "uid": "4", "updated_at": "xyz789", "upsell_products": [ProductInterface], "url_key": "xyz789", @@ -2305,7 +2311,7 @@ Defines basic features of a bundle product and contains multiple BundleItems. "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], - "weight": 123.45 + "weight": 987.65 } ``` @@ -2320,8 +2326,8 @@ Defines a single bundle product. | 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]`](types-c-e.md#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/latest/types-c-e.md#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](/reference/graphql/latest/types-c-e.md#cartiteminput) | The quantity and SKU of the bundle product. | #### Example @@ -2343,11 +2349,11 @@ Contains details about bundle products added to a requisition list. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/latest/types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2357,7 +2363,7 @@ Contains details about bundle products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -2371,13 +2377,13 @@ Defines bundle product options for `ShipmentItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/latest/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | #### Example @@ -2386,10 +2392,10 @@ Defines bundle product options for `ShipmentItemInterface`. "bundle_options": [ItemSelectedBundleOption], "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -2403,13 +2409,13 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](/reference/graphql/latest/types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -2418,10 +2424,10 @@ Defines bundle product options for `WishlistItemInterface`. "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -2433,11 +2439,11 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | -| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | -| `label` - [`String`](types-q-s.md#string) | The button label | -| `layout` - [`String`](types-q-s.md#string) | The button layout | -| `shape` - [`String`](types-q-s.md#string) | The button shape | +| `color` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The button color | +| `height` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The button label | +| `layout` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The button layout | +| `shape` - [`String`](/reference/graphql/latest/types-q-s.md#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 | @@ -2445,9 +2451,9 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "xyz789", + "color": "abc123", "height": 987, - "label": "xyz789", + "label": "abc123", "layout": "xyz789", "shape": "abc123", "tagline": false, diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md index 7b207e93c..eecb90477 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md @@ -8,15 +8,15 @@ Specifies the quote template id of the quote template to cancel | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `cancellation_comment` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "cancellation_comment": "abc123", - "template_id": "4" + "template_id": 4 } ``` @@ -29,7 +29,7 @@ Specifies the quote template id of the quote template to cancel | Field Name | Description | |------------|-------------| | `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | #### Example @@ -71,8 +71,8 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | +| `order_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Cancellation reason. | #### Example @@ -93,7 +93,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | +| `error` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Error encountered while cancelling the order. | | `errorV2` - [`CancelOrderError`](#cancelordererror) | | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | @@ -115,7 +115,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](types-q-s.md#string) | | +| `description` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -132,20 +132,20 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| | `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `name` - [`String`](types-q-s.md#string) | Name on the card | +| `card_expiry_month` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Name on the card | #### Example ```json { "bin_details": CardBin, - "card_expiry_month": "abc123", + "card_expiry_month": "xyz789", "card_expiry_year": "xyz789", "last_digits": "abc123", - "name": "abc123" + "name": "xyz789" } ``` @@ -157,12 +157,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](types-q-s.md#string) | Card bin number | +| `bin` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "xyz789"} +{"bin": "abc123"} ``` @@ -175,15 +175,15 @@ The card payment source information | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](types-q-s.md#string) | The name on the cardholder | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](/reference/graphql/latest/types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name on the cardholder | #### Example ```json { "billing_address": BillingAddressPaymentSourceInput, - "name": "xyz789" + "name": "abc123" } ``` @@ -197,9 +197,9 @@ The card payment source information | Field Name | Description | |------------|-------------| -| `brand` - [`String`](types-q-s.md#string) | The brand of the card | -| `expiry` - [`String`](types-q-s.md#string) | The expiry of the card | -| `last_digits` - [`String`](types-q-s.md#string) | The last digits of the card | +| `brand` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The brand of the card | +| `expiry` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The expiry of the card | +| `last_digits` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The last digits of the card | #### Example @@ -207,7 +207,7 @@ The card payment source information { "brand": "abc123", "expiry": "xyz789", - "last_digits": "abc123" + "last_digits": "xyz789" } ``` @@ -221,28 +221,28 @@ Contains the contents and other details about a guest or customer cart. | Field Name | Description | |------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart contains only virtual products. | +| `applied_coupon` - [`AppliedCoupon`](/reference/graphql/latest/types-a-b.md#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](/reference/graphql/latest/types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](/reference/graphql/latest/types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](/reference/graphql/latest/types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](/reference/graphql/latest/types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/latest/types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](/reference/graphql/latest/types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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!`](types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/latest/types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](/reference/graphql/latest/types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -260,7 +260,7 @@ Contains the contents and other details about a guest or customer cart. "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "is_virtual": false, "items": [CartItemInterface], "itemsV2": CartItems, @@ -283,14 +283,14 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The country code. | -| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The country code. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display label for the country. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "xyz789" } ``` @@ -305,39 +305,39 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String!`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/latest/types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country_code": "xyz789", "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "abc123", - "lastname": "abc123", + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", "middlename": "abc123", "postcode": "xyz789", "prefix": "xyz789", - "region": "abc123", + "region": "xyz789", "region_id": 123, "save_in_address_book": false, "street": ["xyz789"], @@ -355,52 +355,52 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company specified for the billing or shipping address. | | `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | | `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | -| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | +| [`ShippingCartAddress`](/reference/graphql/latest/types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](/reference/graphql/latest/types-a-b.md#billingcartaddress) | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", "fax": "xyz789", "firstname": "abc123", - "id": 123, - "lastname": "xyz789", + "id": 987, + "lastname": "abc123", "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "abc123", "uid": 4, "vat_id": "abc123" } @@ -416,17 +416,17 @@ Contains details about the region in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The state or province code. | -| `label` - [`String`](types-q-s.md#string) | The display label for the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The state or province code. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "abc123", - "label": "abc123", - "region_id": 987 + "code": "xyz789", + "label": "xyz789", + "region_id": 123 } ``` @@ -440,15 +440,15 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](types-q-s.md#string) | The description of the discount. | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | The description of the discount. | #### Example ```json { "amount": Money, - "label": ["abc123"] + "label": ["xyz789"] } ``` @@ -478,12 +478,12 @@ Contains information about discounts applied to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message | #### Example ```json -{"code": "UNDEFINED", "message": "xyz789"} +{"code": "UNDEFINED", "message": "abc123"} ``` @@ -515,10 +515,10 @@ Defines an item to be added to the cart. | Input Field | Description | |-------------|-------------| | `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | +| `parent_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](/reference/graphql/latest/types-f-i.md#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!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the product. | #### Example @@ -544,28 +544,28 @@ An interface for products in a cart. |------------|-------------| | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`SimpleCartItem`](types-q-s.md#simplecartitem) | -| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | +| [`SimpleCartItem`](/reference/graphql/latest/types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](/reference/graphql/latest/types-t-z.md#virtualcartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](types-a-b.md#bundlecartitem) | -| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | +| [`BundleCartItem`](/reference/graphql/latest/types-a-b.md#bundlecartitem) | +| [`GiftCardCartItem`](/reference/graphql/latest/types-f-i.md#giftcardcartitem) | #### Example @@ -574,15 +574,15 @@ An interface for products in a cart. "discount": [Discount], "errors": [CartItemError], "id": "xyz789", - "is_available": true, + "is_available": false, "max_qty": 123.45, - "min_qty": 123.45, - "not_available_message": "xyz789", + "min_qty": 987.65, + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -597,17 +597,17 @@ Contains details about the price of the item, including taxes and discounts. | Field Name | Description | |------------|-------------| -| `catalog_discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | +| `catalog_discount` - [`ProductDiscount`](/reference/graphql/latest/types-k-p.md#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]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | -| `original_item_price` - [`Money!`](types-k-p.md#money) | The value of the original unit price for the item, including discounts. | -| `original_row_total` - [`Money!`](types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | -| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/latest/types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](/reference/graphql/latest/types-k-p.md#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!`](/reference/graphql/latest/types-k-p.md#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`](/reference/graphql/latest/types-k-p.md#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!`](/reference/graphql/latest/types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -637,13 +637,13 @@ Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInte | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `cart_item_id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart_item_id": 123, "quantity": 987.65} +{"cart_item_id": 987, "quantity": 123.45} ``` @@ -656,16 +656,16 @@ Contains details about the price of a selected customizable value. | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](types-f-i.md#float) | A price value. | +| `type` - [`PriceTypeEnum!`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | A price value. | #### Example ```json { "type": "FIXED", - "units": "abc123", + "units": "xyz789", "value": 123.45 } ``` @@ -680,19 +680,19 @@ A single item to be updated. | Input Field | Description | |-------------|-------------| -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | | `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/latest/types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The new quantity of the item. | #### Example ```json { - "cart_item_id": 987, - "cart_item_uid": 4, + "cart_item_id": 123, + "cart_item_uid": "4", "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": "4", @@ -709,8 +709,8 @@ A single item to be updated. | Field Name | Description | |------------|-------------| | `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of returned cart items. | #### Example @@ -718,7 +718,7 @@ A single item to be updated. { "items": [CartItemInterface], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -735,12 +735,12 @@ Contains details about the final price of items in the cart, including discount | `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`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | -| `grand_total_excluding_tax` - [`Money`](types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | -| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/latest/types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -766,7 +766,7 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartRule` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartRule` object. | #### Example @@ -784,8 +784,8 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The description of the tax. | #### Example @@ -805,14 +805,14 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -872,29 +872,29 @@ Swatch attribute metadata. | Field Name | Description | |------------|-------------| | `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/latest/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/latest/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](/reference/graphql/latest/types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example @@ -911,18 +911,18 @@ Swatch attribute metadata. "is_filterable_in_search": true, "is_html_allowed_on_front": true, "is_required": true, - "is_searchable": false, - "is_unique": true, + "is_searchable": true, + "is_unique": false, "is_used_for_price_rules": false, - "is_used_for_promo_rules": false, + "is_used_for_promo_rules": true, "is_visible_in_advanced_search": false, "is_visible_on_front": false, - "is_wysiwyg_enabled": true, - "label": "abc123", + "is_wysiwyg_enabled": false, + "label": "xyz789", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", "update_product_preview_image": false, - "use_product_image_for_swatch": true, + "use_product_image_for_swatch": false, "used_in_product_listing": false } ``` @@ -937,13 +937,13 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/latest/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by the URL path for the category. | #### Example @@ -969,39 +969,39 @@ Contains the full set of attributes that can be returned in a category search. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | +| `automatic_sorting` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/latest/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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`](/reference/graphql/latest/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/latest/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Possible Types @@ -1021,31 +1021,31 @@ Contains the full set of attributes that can be returned in a category search. "cms_block": CmsBlock, "created_at": "abc123", "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", - "description": "abc123", + "default_sort_by": "xyz789", + "description": "xyz789", "display_mode": "xyz789", - "filter_price_range": 123.45, - "id": 123, - "image": "abc123", - "include_in_menu": 123, + "filter_price_range": 987.65, + "id": 987, + "image": "xyz789", + "include_in_menu": 987, "is_anchor": 987, - "landing_page": 987, + "landing_page": 123, "level": 123, "meta_description": "abc123", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "abc123", - "name": "abc123", - "path": "abc123", + "name": "xyz789", + "path": "xyz789", "path_in_store": "xyz789", - "position": 123, - "product_count": 123, + "position": 987, + "product_count": 987, "products": CategoryProducts, "staged": true, - "uid": 4, + "uid": "4", "updated_at": "xyz789", "url_key": "abc123", - "url_path": "abc123", - "url_suffix": "abc123" + "url_path": "xyz789", + "url_suffix": "xyz789" } ``` @@ -1059,9 +1059,9 @@ Contains details about the products assigned to a category. | Field Name | Description | |------------|-------------| -| `items` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `items` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#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 @@ -1084,8 +1084,8 @@ Contains a collection of `CategoryTree` objects and pagination information. | Field Name | Description | |------------|-------------| | `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of categories that match the criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The total number of categories that match the criteria. | #### Example @@ -1093,7 +1093,7 @@ Contains a collection of `CategoryTree` objects and pagination information. { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1107,85 +1107,85 @@ Contains the hierarchy of categories. | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](types-q-s.md#string) | | -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled. | +| `automatic_sorting` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `available_sort_by` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/latest/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | | +| `children_count` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | | `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `id` - [`Int`](types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/latest/types-f-i.md#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!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the category URL that is appended after the url key | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "automatic_sorting": "abc123", - "available_sort_by": ["xyz789"], + "automatic_sorting": "xyz789", + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "abc123", - "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", + "custom_layout_update_file": "abc123", + "default_sort_by": "xyz789", "description": "abc123", "display_mode": "xyz789", - "filter_price_range": 987.65, + "filter_price_range": 123.45, "id": 987, - "image": "abc123", - "include_in_menu": 987, - "is_anchor": 123, + "image": "xyz789", + "include_in_menu": 123, + "is_anchor": 987, "landing_page": 987, "level": 987, "meta_description": "xyz789", "meta_keywords": "abc123", - "meta_title": "xyz789", - "name": "abc123", + "meta_title": "abc123", + "name": "xyz789", "path": "abc123", - "path_in_store": "abc123", - "position": 987, + "path_in_store": "xyz789", + "position": 123, "product_count": 123, "products": CategoryProducts, "redirect_code": 123, - "relative_url": "xyz789", - "staged": true, + "relative_url": "abc123", + "staged": false, "type": "CMS_PAGE", - "uid": "4", - "updated_at": "xyz789", - "url_key": "abc123", - "url_path": "abc123", - "url_suffix": "abc123" + "uid": 4, + "updated_at": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", + "url_suffix": "xyz789" } ``` @@ -1199,25 +1199,25 @@ Defines details about an individual checkout agreement. | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | -| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | +| `agreement_id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | | `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name given to the condition. | #### Example ```json { - "agreement_id": 123, - "checkbox_text": "xyz789", - "content": "abc123", - "content_height": "xyz789", - "is_html": false, + "agreement_id": 987, + "checkbox_text": "abc123", + "content": "xyz789", + "content_height": "abc123", + "is_html": true, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ``` @@ -1251,15 +1251,15 @@ An error encountered while adding an item to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `path` - [`[String]!`](types-q-s.md#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 | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](/reference/graphql/latest/types-q-s.md#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": "xyz789", + "message": "abc123", "path": ["abc123"] } ``` @@ -1294,13 +1294,13 @@ Contains details about errors encountered when a customer clear cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message | | `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -1332,7 +1332,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Cart` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `Cart` object. | #### Example @@ -1373,12 +1373,12 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example ```json -{"cart": Cart, "status": false} +{"cart": Cart, "status": true} ``` @@ -1389,9 +1389,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/latest/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/latest/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/latest/types-f-i.md#internalerror) | #### Example @@ -1410,14 +1410,14 @@ Contains details about a failed close operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -1429,7 +1429,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/latest/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1448,7 +1448,7 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example @@ -1466,10 +1466,10 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `closed_quotes` - [`[NegotiableQuote]`](/reference/graphql/latest/types-k-p.md#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/latest/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/latest/types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1494,17 +1494,17 @@ Contains details about a specific CMS block. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](types-q-s.md#string) | The CMS block identifier. | -| `title` - [`String`](types-q-s.md#string) | The title assigned to the CMS block. | +| `content` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The CMS block identifier. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The title assigned to the CMS block. | #### Example ```json { "content": "abc123", - "identifier": "abc123", - "title": "abc123" + "identifier": "xyz789", + "title": "xyz789" } ``` @@ -1536,35 +1536,35 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `content` - [`String`](types-q-s.md#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](types-q-s.md#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](types-q-s.md#string) | The ID of a CMS page. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](types-q-s.md#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | +| `content` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ID of a CMS page. | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { "content": "xyz789", - "content_heading": "xyz789", + "content_heading": "abc123", "identifier": "abc123", "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", + "meta_keywords": "xyz789", + "meta_title": "xyz789", "page_layout": "abc123", "redirect_code": 987, "relative_url": "abc123", "title": "xyz789", "type": "CMS_PAGE", - "url_key": "abc123" + "url_key": "xyz789" } ``` @@ -1576,12 +1576,12 @@ Contains details about a CMS page. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1613,7 +1613,7 @@ Specifies which field to sort on, and whether to return the results in ascending | Input Field | Description | |-------------|-------------| | `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | +| `order` - [`SortEnum!`](/reference/graphql/latest/types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1635,13 +1635,13 @@ Contains the output schema for a 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`](types-q-s.md#string) | The email address of the company contact. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | -| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](/reference/graphql/latest/types-q-s.md#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. | @@ -1649,7 +1649,7 @@ Contains the output schema for a company. | `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`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1665,7 +1665,7 @@ Contains the output schema for a company. "legal_name": "abc123", "name": "xyz789", "payment_methods": ["xyz789"], - "reseller_id": "abc123", + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1688,9 +1688,9 @@ Contains details about the access control list settings of a resource. | Field Name | Description | |------------|-------------| | `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | -| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the ACL resource. | #### Example @@ -1713,24 +1713,24 @@ Defines the input schema for creating a company administrator. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | -| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | -| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | -| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company administrator. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/latest/types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company administrator's last name. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The phone number of the company administrator. | #### Example ```json { "custom_attributes": [AttributeValueInput], - "email": "xyz789", - "firstname": "xyz789", - "gender": 987, + "email": "abc123", + "firstname": "abc123", + "gender": 123, "job_title": "abc123", - "lastname": "abc123", + "lastname": "xyz789", "telephone": "abc123" } ``` @@ -1745,9 +1745,9 @@ The minimal required information to identify and display the company. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the company. | | `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | #### Example @@ -1755,7 +1755,7 @@ The minimal required information to identify and display the company. ```json { "id": 4, - "legal_name": "abc123", + "legal_name": "xyz789", "name": "abc123", "status": "PENDING" } @@ -1772,24 +1772,24 @@ Defines the input schema for creating a new company. | Input Field | Description | |-------------|-------------| | `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String!`](types-q-s.md#string) | The name of the company to create. | +| `company_email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the company to create. | | `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { "company_admin": CompanyAdminInput, - "company_email": "xyz789", - "company_name": "xyz789", + "company_email": "abc123", + "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, "legal_name": "xyz789", - "reseller_id": "abc123", - "vat_tax_id": "xyz789" + "reseller_id": "xyz789", + "vat_tax_id": "abc123" } ``` @@ -1803,9 +1803,9 @@ Contains company credit balances and limits. | Field Name | Description | |------------|-------------| -| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](types-k-p.md#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. | +| `available_credit` - [`Money!`](/reference/graphql/latest/types-k-p.md#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!`](/reference/graphql/latest/types-k-p.md#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](/reference/graphql/latest/types-k-p.md#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 @@ -1828,8 +1828,8 @@ Contains details about prior company credit operations. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1851,9 +1851,9 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The name of the person submitting the company credit operation. | +| `updated_by` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example @@ -1875,10 +1875,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the company credit operation. | +| `amount` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The amount of the company credit operation. | | `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](types-q-s.md#string) | The date the operation occurred. | +| `custom_reference_number` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](/reference/graphql/latest/types-q-s.md#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. | @@ -1926,7 +1926,7 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#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 @@ -1962,8 +1962,8 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The invitation code. | -| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example @@ -1971,7 +1971,7 @@ Defines the input schema for accepting the company invitation. ```json { "code": "xyz789", - "role_id": "4", + "role_id": 4, "user": CompanyInvitationUserInput } ``` @@ -1986,7 +1986,7 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example @@ -2004,17 +2004,17 @@ Company user attributes in the invitation. | Input Field | Description | |-------------|-------------| -| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | -| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `company_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The job title of a company user. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The phone number of the company user. | #### Example ```json { - "company_id": "4", + "company_id": 4, "customer_id": 4, "job_title": "xyz789", "status": "ACTIVE", @@ -2032,12 +2032,12 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The company's postal code. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company's postal code. | | `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | +| `street` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company's phone number. | #### Example @@ -2062,12 +2062,12 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String!`](/reference/graphql/latest/types-q-s.md#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]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2078,7 +2078,7 @@ Defines the input schema for defining a company's legal address. "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["xyz789"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2092,12 +2092,12 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The city where the company is registered to conduct business. | | `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2108,7 +2108,7 @@ Defines the input schema for updating a company's legal address. "postcode": "xyz789", "region": CustomerAddressRegionInput, "street": ["abc123"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -2122,17 +2122,17 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the role. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name assigned to the role. | | `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | +| `users_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { - "id": "4", - "name": "xyz789", + "id": 4, + "name": "abc123", "permissions": [CompanyAclResource], "users_count": 123 } @@ -2148,8 +2148,8 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | -| `permissions` - [`[String]!`](types-q-s.md#string) | A list of resources the role can access. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | A list of resources the role can access. | #### Example @@ -2170,16 +2170,16 @@ Defines the input schema for updating a company role. | Input Field | Description | |-------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | -| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | A list of resources the role can access. | #### Example ```json { - "id": 4, - "name": "xyz789", + "id": "4", + "name": "abc123", "permissions": ["xyz789"] } ``` @@ -2195,8 +2195,8 @@ Contains an array of roles. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2204,7 +2204,7 @@ Contains an array of roles. { "items": [CompanyRole], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2218,17 +2218,17 @@ Contains details about a company sales representative. | Field Name | Description | |------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | -| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | -| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "xyz789", - "firstname": "abc123", - "lastname": "abc123" + "email": "abc123", + "firstname": "xyz789", + "lastname": "xyz789" } ``` @@ -2299,13 +2299,17 @@ Defines an individual node in the company structure. | Field Name | Description | |------------|-------------| | `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example ```json -{"entity": CompanyTeam, "id": 4, "parent_id": 4} +{ + "entity": CompanyTeam, + "id": "4", + "parent_id": 4 +} ``` @@ -2318,13 +2322,13 @@ Defines the input schema for updating the company structure. | Input Field | Description | |-------------|-------------| -| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | +| `parent_tree_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": "4", "tree_id": 4} +{"parent_tree_id": 4, "tree_id": 4} ``` @@ -2337,10 +2341,10 @@ Describes a company team. | Field Name | Description | |------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | -| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | ID of the company structure | #### Example @@ -2363,16 +2367,16 @@ Defines the input schema for creating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "description": "xyz789", - "name": "abc123", + "description": "abc123", + "name": "xyz789", "target_id": "4" } ``` @@ -2387,17 +2391,17 @@ Defines the input schema for updating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the team. | #### Example ```json { "description": "xyz789", - "id": "4", - "name": "abc123" + "id": 4, + "name": "xyz789" } ``` @@ -2411,12 +2415,12 @@ Defines the input schema for updating a company. | Input Field | Description | |-------------|-------------| -| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String`](types-q-s.md#string) | The name of the company to update. | +| `company_email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the company to update. | | `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -2425,8 +2429,8 @@ Defines the input schema for updating a company. "company_email": "xyz789", "company_name": "xyz789", "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "abc123", - "reseller_id": "abc123", + "legal_name": "xyz789", + "reseller_id": "xyz789", "vat_tax_id": "xyz789" } ``` @@ -2441,27 +2445,27 @@ Defines the input schema for creating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The company user's email address | -| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | -| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | -| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | +| `target_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", - "firstname": "abc123", - "job_title": "abc123", + "email": "abc123", + "firstname": "xyz789", + "job_title": "xyz789", "lastname": "xyz789", - "role_id": "4", + "role_id": 4, "status": "ACTIVE", "target_id": "4", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2494,25 +2498,25 @@ Defines the input schema for updating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The company user's email address. | -| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "firstname": "abc123", "id": "4", - "job_title": "abc123", + "job_title": "xyz789", "lastname": "abc123", - "role_id": "4", + "role_id": 4, "status": "ACTIVE", "telephone": "abc123" } @@ -2529,8 +2533,8 @@ Contains details about company users. | Field Name | Description | |------------|-------------| | `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of objects returned. | #### Example @@ -2570,15 +2574,15 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The label of the attribute code. | #### Example ```json { - "code": "xyz789", - "label": "abc123" + "code": "abc123", + "label": "xyz789" } ``` @@ -2592,9 +2596,9 @@ Defines an object used to iterate through items for product comparisons. | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | +| `attributes` - [`[ProductAttribute]!`](/reference/graphql/latest/types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2617,16 +2621,16 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| | `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](types-f-i.md#int) | The number of items in the compare list. | +| `item_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of items in the compare list. | | `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example ```json { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -2642,15 +2646,15 @@ Update the quote and complete the order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | +| `cartId` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | #### Example ```json { - "cartId": "abc123", - "id": "xyz789" + "cartId": "xyz789", + "id": "abc123" } ``` @@ -2662,7 +2666,7 @@ Update the quote and complete the order | Field Name | Description | |------------|-------------| -| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | +| `html` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Text that can contain HTML tags. | #### Example @@ -2680,17 +2684,17 @@ Contains details about a configurable product attribute option. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | -| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example ```json { "code": "abc123", - "label": "abc123", + "label": "xyz789", "uid": 4, "value_index": 987 } @@ -2706,25 +2710,25 @@ An implementation for configurable product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](/reference/graphql/latest/types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#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`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -2739,16 +2743,16 @@ An implementation for configurable product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "xyz789", - "is_available": false, + "is_available": true, "max_qty": 987.65, - "min_qty": 123.45, - "not_available_message": "abc123", + "min_qty": 987.65, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -2762,8 +2766,8 @@ Describes configurable options that have been selected and can be selected as a | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | +| `attribute_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of selectable option value IDs. | #### Example @@ -2783,28 +2787,28 @@ Describes configurable options that have been selected and can be selected as a | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/latest/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the order item. | #### Example @@ -2816,23 +2820,23 @@ Describes configurable options that have been selected and can be selected as a "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "xyz789", + "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "xyz789", "product_url_key": "xyz789", - "quantity_canceled": 123.45, + "quantity_canceled": 987.65, "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -2846,72 +2850,72 @@ Defines basic features of a configurable product and its simple product variants | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `attribute_set_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `country_of_manufacture` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/latest/types-k-p.md#productcustomattributes) | Product custom attributes. | | `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `gift_message_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/latest/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `options_container` - [`String`](/reference/graphql/latest/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/latest/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/latest/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/latest/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/latest/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/latest/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/latest/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -2934,18 +2938,18 @@ Defines basic features of a configurable product and its simple product variants "id": 123, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 987, + "manufacturer": 123, "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, + "meta_title": "abc123", + "min_sale_qty": 123.45, "name": "xyz789", - "new_from_date": "xyz789", + "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "abc123", "price": ProductPrices, @@ -2957,27 +2961,27 @@ Defines basic features of a configurable product and its simple product variants "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "abc123", - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "xyz789", + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "abc123", "staged": false, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "abc123", - "uid": "4", + "uid": 4, "updated_at": "xyz789", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", + "url_key": "xyz789", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "variants": [ConfigurableVariant], @@ -2996,8 +3000,8 @@ Defines basic features of a configurable product and its simple product variants |-------------|-------------| | `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`](types-q-s.md#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](types-q-s.md#string) | | +| `parent_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -3020,18 +3024,18 @@ Contains details about configurable product options. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the configurable option. | +| `attribute_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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": "abc123", + "attribute_code": "xyz789", "label": "abc123", - "uid": "4", + "uid": 4, "values": [ConfigurableProductOptionValue] } ``` @@ -3046,17 +3050,17 @@ Defines a value for a configurable product option. | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | +| `is_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](/reference/graphql/latest/types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the value. | #### Example ```json { - "is_available": true, + "is_available": false, "is_use_default": true, "label": "xyz789", "swatch": SwatchDataInterface, @@ -3074,32 +3078,32 @@ Defines configurable attributes for the specified product. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is the default. | +| `attribute_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](/reference/graphql/latest/types-f-i.md#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!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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": "abc123", + "attribute_code": "abc123", + "attribute_id": "xyz789", "attribute_id_v2": 987, "attribute_uid": "4", - "id": 987, - "label": "abc123", + "id": 123, + "label": "xyz789", "position": 123, - "product_id": 987, - "uid": 4, - "use_default": false, + "product_id": 123, + "uid": "4", + "use_default": true, "values": [ConfigurableProductOptionsValues] } ``` @@ -3115,9 +3119,9 @@ Contains metadata corresponding to the selected configurable options. | Field Name | Description | |------------|-------------| | `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#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`](types-q-s.md#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. | +| `variant` - [`SimpleProduct`](/reference/graphql/latest/types-q-s.md#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 @@ -3142,13 +3146,13 @@ Contains the index number assigned to a configurable product option. | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | -| `label` - [`String`](types-q-s.md#string) | The label of the product. | -| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | +| `default_label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](/reference/graphql/latest/types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example @@ -3156,10 +3160,10 @@ Contains the index number assigned to a configurable product option. { "default_label": "abc123", "label": "xyz789", - "store_label": "abc123", + "store_label": "xyz789", "swatch_data": SwatchDataInterface, - "uid": "4", - "use_default_value": true, + "uid": 4, + "use_default_value": false, "value_index": 123 } ``` @@ -3174,11 +3178,11 @@ Contains details about configurable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](/reference/graphql/latest/types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -3187,7 +3191,7 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" } ``` @@ -3203,7 +3207,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](/reference/graphql/latest/types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -3224,15 +3228,15 @@ A configurable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](types-q-s.md#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]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#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]`](/reference/graphql/latest/types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -3244,7 +3248,7 @@ A configurable product wish list item. "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": 4, + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -3258,8 +3262,8 @@ A configurable product wish list item. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an `Order` type. | #### Example @@ -3280,8 +3284,8 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | -| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address to be confirmed. | #### Example @@ -3300,15 +3304,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an `Order` type. | #### Example ```json { "confirmation_key": "abc123", - "order_id": "4" + "order_id": 4 } ``` @@ -3339,19 +3343,19 @@ List of account confirmation statuses. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | -| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | -| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | +| `comment` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The shopper's telephone number. | #### Example ```json { - "comment": "xyz789", + "comment": "abc123", "email": "abc123", - "name": "abc123", - "telephone": "xyz789" + "name": "xyz789", + "telephone": "abc123" } ``` @@ -3365,12 +3369,12 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example ```json -{"status": false} +{"status": true} ``` @@ -3383,7 +3387,7 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example @@ -3401,7 +3405,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3419,9 +3423,9 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/latest/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3441,19 +3445,19 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | -| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | -| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | +| `available_regions` - [`[Region]`](/reference/graphql/latest/types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { "available_regions": [Region], - "full_name_english": "xyz789", + "full_name_english": "abc123", "full_name_locale": "abc123", "id": "abc123", "three_letter_abbreviation": "xyz789", @@ -3805,12 +3809,12 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](/reference/graphql/latest/types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example ```json -{"products": [4]} +{"products": ["4"]} ``` @@ -3823,14 +3827,14 @@ Defines a new gift registry. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | -| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/latest/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](/reference/graphql/latest/types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](/reference/graphql/latest/types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/latest/types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](/reference/graphql/latest/types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3839,7 +3843,7 @@ Defines a new gift registry. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "xyz789", + "event_name": "abc123", "gift_registry_type_uid": 4, "message": "xyz789", "privacy_settings": "PRIVATE", @@ -3859,7 +3863,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3875,12 +3879,12 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | Optional client-generated ID | #### Example ```json -{"cart_uid": 4} +{"cart_uid": "4"} ``` @@ -3909,19 +3913,19 @@ Contains the secure information used to authorize transaction. Applies to Payflo | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](types-f-i.md#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](types-q-s.md#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](types-q-s.md#string) | A secure token ID generated by PayPal. | +| `response_message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A secure token ID generated by PayPal. | #### Example ```json { - "response_message": "abc123", - "result": 123, - "result_code": 123, + "response_message": "xyz789", + "result": 987, + "result_code": 987, "secure_token": "xyz789", "secure_token_id": "abc123" } @@ -3937,21 +3941,21 @@ Contains payment order details that are used while processing the payment order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | +| `cartId` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](/reference/graphql/latest/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example ```json { - "cartId": "xyz789", + "cartId": "abc123", "location": "PRODUCT_DETAIL", "methodCode": "abc123", - "paymentSource": "xyz789", - "vaultIntent": true + "paymentSource": "abc123", + "vaultIntent": false } ``` @@ -3965,21 +3969,21 @@ Contains payment order details that are used while processing the payment order | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | -| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `amount` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the payment order | #### Example ```json { - "amount": 123.45, + "amount": 987.65, "currency_code": "xyz789", "id": "abc123", "mp_order_id": "xyz789", - "status": "abc123" + "status": "xyz789" } ``` @@ -3993,21 +3997,21 @@ Defines a new product review. | Input Field | Description | |-------------|-------------| -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `nickname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](/reference/graphql/latest/types-k-p.md#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The review text. | #### Example ```json { - "nickname": "abc123", + "nickname": "xyz789", "ratings": [ProductReviewRatingInput], "sku": "abc123", "summary": "xyz789", - "text": "abc123" + "text": "xyz789" } ``` @@ -4021,7 +4025,7 @@ Contains the completed product review. | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](types-k-p.md#productreview) | Product review details. | +| `review` - [`ProductReview!`](/reference/graphql/latest/types-k-p.md#productreview) | Product review details. | #### Example @@ -4040,7 +4044,7 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example @@ -4059,9 +4063,9 @@ Defines a set of conditions that apply to a rule. | 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!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -4084,15 +4088,15 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name assigned to the requisition list. | #### Example ```json { "description": "abc123", - "name": "abc123" + "name": "xyz789" } ``` @@ -4106,7 +4110,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -4124,8 +4128,8 @@ Describe the variables needed to create a vault payment token | Input Field | Description | |-------------|-------------| -| `card_description` - [`String`](types-q-s.md#string) | Description of the vaulted card | -| `setup_token_id` - [`String!`](types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | +| `card_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example @@ -4146,15 +4150,15 @@ The vault token id and information about the payment source | Field Name | Description | |------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](types-k-p.md#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](types-q-s.md#string) | The vault payment token information | +| `payment_source` - [`PaymentSourceOutput!`](/reference/graphql/latest/types-k-p.md#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The vault payment token information | #### Example ```json { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } ``` @@ -4168,8 +4172,8 @@ Describe the variables needed to create a vault card setup token | Input Field | Description | |-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](types-t-z.md#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | The 3DS mode | +| `setup_token` - [`VaultSetupTokenInput!`](/reference/graphql/latest/types-t-z.md#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/latest/types-t-z.md#threedsmode) | The 3DS mode | #### Example @@ -4190,7 +4194,7 @@ The setup token id information | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](types-q-s.md#string) | The setup token id | +| `setup_token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The setup token id | #### Example @@ -4208,8 +4212,8 @@ Defines the name and visibility of a new wish list. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](/reference/graphql/latest/types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -4227,7 +4231,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -4245,18 +4249,18 @@ Required fields for Payflow Pro and Payments Pro credit card payments. | Input Field | Description | |-------------|-------------| -| `cc_exp_month` - [`Int!`](types-f-i.md#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](types-f-i.md#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](types-f-i.md#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](types-q-s.md#string) | The credit card type. | +| `cc_exp_month` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The credit card type. | #### Example ```json { - "cc_exp_month": 987, - "cc_exp_year": 987, - "cc_last_4": 987, + "cc_exp_month": 123, + "cc_exp_year": 123, + "cc_last_4": 123, "cc_type": "abc123" } ``` @@ -4271,10 +4275,10 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemo` object. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/latest/types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CreditMemo` object. | | `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | +| `number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -4284,7 +4288,7 @@ Contains credit memo details. "comments": [SalesCommentItem], "id": "4", "items": [CreditMemoItemInterface], - "number": "xyz789", + "number": "abc123", "total": CreditMemoTotal } ``` @@ -4298,24 +4302,24 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | #### Example ```json { "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -4330,20 +4334,20 @@ Credit memo item details. | Field Name | Description | |------------|-------------| | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | +| [`BundleCreditMemoItem`](/reference/graphql/latest/types-a-b.md#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](/reference/graphql/latest/types-f-i.md#giftcardcreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | #### Example @@ -4353,10 +4357,10 @@ Credit memo item details. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 + "product_sku": "abc123", + "quantity_refunded": 987.65 } ``` @@ -4370,15 +4374,15 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `adjustment` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The final base grand total amount in the base currency. | | `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | +| `grand_total` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/latest/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/latest/types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4404,26 +4408,26 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](types-q-s.md#string) | The currency symbol that is displayed by default, such as $. | +| `available_currency_codes` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](/reference/graphql/latest/types-q-s.md#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"], + "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": "xyz789", + "base_currency_symbol": "xyz789", + "default_display_currecy_code": "abc123", + "default_display_currecy_symbol": "abc123", + "default_display_currency_code": "xyz789", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } ``` @@ -4625,7 +4629,7 @@ Defines an array of custom attributes. | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](types-a-b.md#attribute) | An array of attributes. | +| `items` - [`[Attribute]`](/reference/graphql/latest/types-a-b.md#attribute) | An array of attributes. | #### Example @@ -4643,37 +4647,37 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/latest/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/latest/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](types-a-b.md#attributemetadata) | +| [`AttributeMetadata`](/reference/graphql/latest/types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](/reference/graphql/latest/types-q-s.md#returnitemattributemetadata) | #### Example ```json { - "code": 4, + "code": "4", "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "is_required": false, - "is_unique": true, - "label": "abc123", + "is_unique": false, + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -4686,21 +4690,21 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `is_default` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](/reference/graphql/latest/types-a-b.md#attributeoptionmetadata) | #### Example ```json { - "is_default": false, + "is_default": true, "label": "xyz789", "value": "abc123" } @@ -4718,53 +4722,53 @@ Defines the customer name, addresses, and other details. |------------|-------------| | `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!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](types-t-z.md#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `allow_remote_shopping_assistance` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](/reference/graphql/latest/types-t-z.md#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`](types-q-s.md#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | Details about a specific gift registry. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](/reference/graphql/latest/types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | Details about a specific gift registry. | | `group` - [`CustomerGroupStorefront`](#customergroupstorefront) | Customer group assigned to the customer | -| `group_id` - [`Int`](types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the customer. | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `group_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID assigned to the customer. | +| `is_subscribed` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's middle name. | | `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](types-q-s.md#rewardpoints) | Customer reward points details. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](/reference/graphql/latest/types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](/reference/graphql/latest/types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](/reference/graphql/latest/types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](/reference/graphql/latest/types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](/reference/graphql/latest/types-q-s.md#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](/reference/graphql/latest/types-q-s.md#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!`](types-f-i.md#id) | ID of the company structure | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `structure_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#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. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](/reference/graphql/latest/types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/latest/types-t-z.md#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 @@ -4776,23 +4780,23 @@ Defines the customer name, addresses, and other details. "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "abc123", + "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", "default_shipping": "xyz789", - "dob": "xyz789", - "email": "xyz789", + "dob": "abc123", + "email": "abc123", "firstname": "abc123", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "group_id": 123, + "group_id": 987, "id": "4", "is_subscribed": false, - "job_title": "xyz789", - "lastname": "xyz789", + "job_title": "abc123", + "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, "prefix": "xyz789", @@ -4811,11 +4815,11 @@ Defines the customer name, addresses, and other details. "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, - "suffix": "xyz789", + "structure_id": "4", + "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -4832,39 +4836,39 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's company. | | `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](types-q-s.md#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `country_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | | `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `customer_id` - [`Int`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the customer's default shipping address. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `fax` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-f-i.md#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CustomerAddress` object. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomerAddress` object. | +| `vat_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 987, @@ -4872,10 +4876,10 @@ Contains detailed information about a customer's billing or shipping address. "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", - "firstname": "abc123", - "id": 987, - "lastname": "abc123", - "middlename": "xyz789", + "firstname": "xyz789", + "id": 123, + "lastname": "xyz789", + "middlename": "abc123", "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, @@ -4883,7 +4887,7 @@ Contains detailed information about a customer's billing or shipping address. "street": ["xyz789"], "suffix": "xyz789", "telephone": "xyz789", - "uid": 4, + "uid": "4", "vat_id": "abc123" } ``` @@ -4898,8 +4902,8 @@ Specifies the attribute code and value of a customer address attribute. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | +| `attribute_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example @@ -4920,15 +4924,15 @@ Specifies the attribute code and value of a customer attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The name assigned to the attribute. | -| `value` - [`String!`](types-q-s.md#string) | The value assigned to the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name assigned to the attribute. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "xyz789", - "value": "abc123" + "attribute_code": "abc123", + "value": "xyz789" } ``` @@ -4942,49 +4946,49 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributesV2` - [`[AttributeValueInput]`](/reference/graphql/latest/types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `street` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "AF", "custom_attributes": [CustomerAddressAttributeInput], "custom_attributesV2": [AttributeValueInput], - "default_billing": true, - "default_shipping": true, + "default_billing": false, + "default_shipping": false, "fax": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegionInput, "street": ["abc123"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -4998,17 +5002,17 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "region": "abc123", - "region_code": "abc123", - "region_id": 123 + "region_code": "xyz789", + "region_id": 987 } ``` @@ -5022,16 +5026,16 @@ Defines the customer's state or province. | Input Field | Description | |-------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "xyz789", - "region_code": "abc123", + "region": "abc123", + "region_code": "xyz789", "region_id": 123 } ``` @@ -5045,8 +5049,8 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer addresses. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The total count of customer addresses. | #### Example @@ -5068,36 +5072,36 @@ Customer attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/latest/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/latest/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/latest/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of lines of the attribute value. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/latest/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": "4", - "default_value": "abc123", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": false, - "is_unique": false, + "is_required": true, + "is_unique": true, "label": "xyz789", "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -5112,39 +5116,39 @@ An input object for creating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | | -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/latest/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", - "dob": "abc123", - "email": "xyz789", - "firstname": "abc123", - "gender": 123, + "date_of_birth": "abc123", + "dob": "xyz789", + "email": "abc123", + "firstname": "xyz789", + "gender": 987, "is_subscribed": true, - "lastname": "xyz789", - "middlename": "abc123", - "password": "abc123", + "lastname": "abc123", + "middlename": "xyz789", + "password": "xyz789", "prefix": "xyz789", - "suffix": "abc123", - "taxvat": "abc123" + "suffix": "xyz789", + "taxvat": "xyz789" } ``` @@ -5158,21 +5162,21 @@ Contains details about a single downloadable product. | Field Name | Description | |------------|-------------| -| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | -| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | +| `date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#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", + "download_url": "abc123", + "order_increment_id": "xyz789", "remaining_downloads": "xyz789", - "status": "xyz789" + "status": "abc123" } ``` @@ -5204,7 +5208,7 @@ Data of customer group. | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerGroup` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomerGroup` object. | #### Example @@ -5222,35 +5226,35 @@ An input object that assigns or updates customer attributes. | Input Field | Description | |-------------|-------------| -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `date_of_birth` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { "date_of_birth": "xyz789", - "dob": "abc123", + "dob": "xyz789", "email": "abc123", "firstname": "abc123", "gender": 123, - "is_subscribed": false, + "is_subscribed": true, "lastname": "xyz789", "middlename": "xyz789", "password": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "suffix": "xyz789", - "taxvat": "abc123" + "taxvat": "xyz789" } ``` @@ -5264,39 +5268,39 @@ Contains details about each of the customer's orders. | Field Name | Description | |------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | -| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | -| `available_actions` - [`[OrderActionType]!`](types-k-p.md#orderactiontype) | List of available order actions. | -| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `applied_coupons` - [`[AppliedCoupon]!`](/reference/graphql/latest/types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](/reference/graphql/latest/types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](/reference/graphql/latest/types-k-p.md#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](/reference/graphql/latest/types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/latest/types-q-s.md#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use the `order_date` field instead.)* | | `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `customer_info` - [`OrderCustomerInfo!`](types-k-p.md#ordercustomerinfo) | Returns customer information from order. | -| `email` - [`String`](types-q-s.md#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | `TRUE` if the order is virtual | -| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](types-q-s.md#string) | The order number. | -| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | -| `order_number` - [`String!`](types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | -| `order_status_change_date` - [`String!`](types-q-s.md#string) | The date the order status was last updated. | -| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | -| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | -| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | +| `customer_info` - [`OrderCustomerInfo!`](/reference/graphql/latest/types-k-p.md#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](/reference/graphql/latest/types-f-i.md#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the order was placed. | +| `order_number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use the `number` field instead.)* | +| `order_status_change_date` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](/reference/graphql/latest/types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](/reference/graphql/latest/types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](/reference/graphql/latest/types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](/reference/graphql/latest/types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](/reference/graphql/latest/types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -5306,7 +5310,7 @@ Contains details about each of the customer's orders. "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "created_at": "xyz789", "credit_memos": [CreditMemo], @@ -5315,24 +5319,24 @@ Contains details about each of the customer's orders. "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "grand_total": 987.65, - "id": "4", + "grand_total": 123.45, + "id": 4, "increment_id": "abc123", "invoices": [Invoice], - "is_virtual": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", + "number": "abc123", "order_date": "xyz789", "order_number": "xyz789", - "order_status_change_date": "xyz789", + "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", + "shipping_method": "xyz789", + "status": "abc123", "token": "xyz789", "total": OrderTotal } @@ -5348,7 +5352,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](/reference/graphql/latest/types-q-s.md#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 @@ -5386,19 +5390,19 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| -| `date_of_first_order` - [`String`](types-q-s.md#string) | Date of the first order placed in the store | +| `date_of_first_order` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Date of the first order placed in the store | | `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The total count of customer orders. | #### Example ```json { - "date_of_first_order": "abc123", + "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5412,10 +5416,10 @@ Identifies the filter to use for filtering orders. | Input Field | Description | |-------------|-------------| -| `grand_total` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | -| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | -| `order_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | -| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filters by order status. | +| `grand_total` - [`FilterRangeTypeInput`](/reference/graphql/latest/types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](/reference/graphql/latest/types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](/reference/graphql/latest/types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filters by order status. | #### Example @@ -5456,7 +5460,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](/reference/graphql/latest/types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5474,12 +5478,12 @@ Customer segment details | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerSegment` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomerSegment` object. | #### Example ```json -{"uid": 4} +{"uid": "4"} ``` @@ -5493,8 +5497,8 @@ Contains store credit information with balance and history. | 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`](types-k-p.md#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | +| `current_balance` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5517,8 +5521,8 @@ Lists changes to the amount of store credit available to the customer. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of items returned. | #### Example @@ -5540,19 +5544,19 @@ Contains store credit history information. | Field Name | Description | |------------|-------------| -| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | +| `action` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The date and time when the store credit change was made. | #### Example ```json { - "action": "xyz789", + "action": "abc123", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "abc123" + "date_time_changed": "xyz789" } ``` @@ -5566,7 +5570,7 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | +| `token` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer authorization token. | #### Example @@ -5584,18 +5588,18 @@ An input object for updating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `dob` - [`String`](types-q-s.md#string) | | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/latest/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's date of birth. | +| `dob` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -5606,13 +5610,13 @@ An input object for updating a customer. "date_of_birth": "abc123", "dob": "xyz789", "firstname": "abc123", - "gender": 123, - "is_subscribed": true, - "lastname": "abc123", - "middlename": "xyz789", - "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "xyz789" + "gender": 987, + "is_subscribed": false, + "lastname": "xyz789", + "middlename": "abc123", + "prefix": "xyz789", + "suffix": "abc123", + "taxvat": "abc123" } ``` @@ -5626,24 +5630,24 @@ Contains information about a text area that is defined as part of a customizable | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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": "abc123", + "option_id": 987, + "product_sku": "xyz789", "required": false, "sort_order": 987, "title": "abc123", - "uid": 4, + "uid": "4", "value": CustomizableAreaValue } ``` @@ -5658,21 +5662,21 @@ Defines the price and sku of a product whose page contains a customized text are | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | +| `max_characters` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "max_characters": 123, + "max_characters": 987, "price": 123.45, "price_type": "FIXED", "sku": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5686,22 +5690,22 @@ Contains information about a set of checkbox values that are defined as part of | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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, + "option_id": 123, "required": false, "sort_order": 987, "title": "xyz789", - "uid": "4", + "uid": 4, "value": [CustomizableCheckboxValue] } ``` @@ -5716,13 +5720,13 @@ Defines the price and sku of a product whose page contains a customized set of c | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example @@ -5732,7 +5736,7 @@ Defines the price and sku of a product whose page contains a customized set of c "price": 123.45, "price_type": "FIXED", "sku": "abc123", - "sort_order": 123, + "sort_order": 987, "title": "abc123", "uid": 4 } @@ -5748,12 +5752,12 @@ Contains information about a date picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | #### Example @@ -5762,8 +5766,8 @@ Contains information about a date picker that is defined as part of a customizab { "option_id": 987, "product_sku": "xyz789", - "required": false, - "sort_order": 987, + "required": true, + "sort_order": 123, "title": "xyz789", "uid": "4", "value": CustomizableDateValue @@ -5800,11 +5804,11 @@ Defines the price and sku of a product whose page contains a customized date pic | Field Name | Description | |------------|-------------| -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | | `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example @@ -5828,11 +5832,11 @@ Contains information about a drop down menu that is defined as part of a customi | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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 @@ -5843,7 +5847,7 @@ Contains information about a drop down menu that is defined as part of a customi "required": false, "sort_order": 123, "title": "xyz789", - "uid": 4, + "uid": "4", "value": [CustomizableDropDownValue] } ``` @@ -5858,13 +5862,13 @@ Defines the price and sku of a product whose page contains a customized drop dow | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example @@ -5874,8 +5878,8 @@ Defines the price and sku of a product whose page contains a customized drop dow "price": 987.65, "price_type": "FIXED", "sku": "xyz789", - "sort_order": 987, - "title": "abc123", + "sort_order": 123, + "title": "xyz789", "uid": "4" } ``` @@ -5890,23 +5894,23 @@ Contains information about a text field that is defined as part of a customizabl | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "option_id": 987, + "option_id": 123, "product_sku": "xyz789", "required": true, - "sort_order": 123, - "title": "abc123", + "sort_order": 987, + "title": "xyz789", "uid": "4", "value": CustomizableFieldValue } @@ -5922,21 +5926,21 @@ Defines the price and sku of a product whose page contains a customized text fie | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | +| `max_characters` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { "max_characters": 123, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", - "uid": 4 + "sku": "abc123", + "uid": "4" } ``` @@ -5950,24 +5954,24 @@ Contains information about a file picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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": true, - "sort_order": 987, - "title": "abc123", - "uid": 4, + "option_id": 123, + "product_sku": "abc123", + "required": false, + "sort_order": 123, + "title": "xyz789", + "uid": "4", "value": CustomizableFileValue } ``` @@ -5982,25 +5986,25 @@ Defines the price and sku of a product whose page contains a customized file pic | Field Name | Description | |------------|-------------| -| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | -| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | +| `file_extension` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "file_extension": "xyz789", + "file_extension": "abc123", "image_size_x": 123, "image_size_y": 123, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6014,22 +6018,22 @@ Contains information about a multiselect that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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, + "option_id": 123, "required": true, "sort_order": 123, "title": "xyz789", - "uid": 4, + "uid": "4", "value": [CustomizableMultipleValue] } ``` @@ -6044,24 +6048,24 @@ Defines the price and sku of a product whose page contains a customized multisel | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { "option_type_id": 987, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", "sku": "xyz789", "sort_order": 123, - "title": "abc123", + "title": "xyz789", "uid": "4" } ``` @@ -6076,16 +6080,16 @@ Defines a customizable option. | Input Field | Description | |-------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | The customizable option ID of the product. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The customizable option ID of the product. | +| `uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The string value of the option. | #### Example ```json { - "id": 987, - "uid": "4", + "id": 123, + "uid": 4, "value_string": "abc123" } ``` @@ -6100,11 +6104,11 @@ Contains basic information about a customizable option. It can be implemented by | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -6123,9 +6127,9 @@ Contains basic information about a customizable option. It can be implemented by ```json { - "option_id": 123, - "required": true, - "sort_order": 123, + "option_id": 987, + "required": false, + "sort_order": 987, "title": "abc123", "uid": "4" } @@ -6147,12 +6151,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`VirtualProduct`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`VirtualProduct`](/reference/graphql/latest/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/latest/types-q-s.md#simpleproduct) | | [`ConfigurableProduct`](#configurableproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | +| [`BundleProduct`](/reference/graphql/latest/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/latest/types-f-i.md#giftcardproduct) | #### Example @@ -6170,11 +6174,11 @@ Contains information about a set of radio buttons that are defined as part of a | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `option_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example @@ -6183,8 +6187,8 @@ Contains information about a set of radio buttons that are defined as part of a { "option_id": 987, "required": false, - "sort_order": 123, - "title": "abc123", + "sort_order": 987, + "title": "xyz789", "uid": "4", "value": [CustomizableRadioValue] } @@ -6200,25 +6204,25 @@ Defines the price and sku of a product whose page contains a customized set of r | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/latest/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, + "sku": "abc123", + "sort_order": 987, "title": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6232,7 +6236,7 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example @@ -6250,7 +6254,7 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example @@ -6268,7 +6272,7 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example @@ -6286,7 +6290,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -6302,9 +6306,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/latest/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/latest/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/latest/types-f-i.md#internalerror) | #### Example @@ -6323,7 +6327,7 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -6342,7 +6346,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/latest/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -6361,12 +6365,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -6377,7 +6381,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example @@ -6395,9 +6399,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/latest/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/latest/types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -6422,7 +6426,7 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example @@ -6443,7 +6447,7 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The text of the error message. | +| `message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example @@ -6479,12 +6483,12 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example ```json -{"approval_rule_uids": [4]} +{"approval_rule_uids": ["4"]} ``` @@ -6515,7 +6519,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6533,8 +6537,8 @@ Indicates whether the request to delete the requisition list was successful. | Field Name | Description | |------------|-------------| -| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | +| `requisition_lists` - [`RequisitionLists`](/reference/graphql/latest/types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example @@ -6552,13 +6556,13 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/latest/types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"status": false, "wishlists": [Wishlist]} +{"status": true, "wishlists": [Wishlist]} ``` @@ -6571,13 +6575,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The amount of the discount. | | `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | -| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | +| `coupon` - [`AppliedCoupon`](/reference/graphql/latest/types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6588,7 +6592,7 @@ Specifies the discount type and value for quote line item. "coupon": AppliedCoupon, "is_discounting_locked": true, "label": "xyz789", - "type": "xyz789", + "type": "abc123", "value": 123.45 } ``` @@ -6603,22 +6607,22 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#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!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `max_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -6632,7 +6636,7 @@ An implementation for downloadable product cart items. "links": [DownloadableProductLinks], "max_qty": 987.65, "min_qty": 123.45, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -6655,12 +6659,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | #### Example @@ -6670,9 +6674,9 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 } ``` @@ -6706,12 +6710,12 @@ Defines downloadable product options for `InvoiceItemInterface`. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6723,7 +6727,7 @@ Defines downloadable product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 123.45 } ``` @@ -6738,16 +6742,16 @@ Defines characteristics of the links for downloadable product. | Field Name | Description | |------------|-------------| -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json { "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": 4 } ``` @@ -6764,27 +6768,27 @@ Defines downloadable product options for `OrderItemInterface`. |------------|-------------| | `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`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](/reference/graphql/latest/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the order item. | #### Example @@ -6792,7 +6796,7 @@ Defines downloadable product options for `OrderItemInterface`. { "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -6801,18 +6805,18 @@ Defines downloadable product options for `OrderItemInterface`. "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "xyz789", + "product_sku": "xyz789", + "product_type": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 123.45, "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, - "quantity_returned": 123.45, + "quantity_return_requested": 987.65, + "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -6826,72 +6830,72 @@ Defines a product that the shopper downloads. | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `attribute_set_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `color` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/latest/types-k-p.md#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!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `gift_message_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/latest/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | +| `options_container` - [`String`](/reference/graphql/latest/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/latest/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/latest/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/latest/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | The list of products reviews. | | `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/latest/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/latest/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/latest/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | #### Example @@ -6900,9 +6904,9 @@ Defines a product that the shopper downloads. "attribute_set_id": 123, "canonical_url": "abc123", "categories": [CategoryInterface], - "color": 987, + "color": 123, "country_of_manufacture": "xyz789", - "created_at": "abc123", + "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -6912,10 +6916,10 @@ Defines a product that the shopper downloads. "downloadable_product_samples": [ DownloadableProductSamples ], - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 123, + "id": 987, "image": ProductImage, "is_returnable": "abc123", "links_purchased_separately": 123, @@ -6924,23 +6928,23 @@ Defines a product that the shopper downloads. "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "abc123", + "name": "xyz789", "new_from_date": "abc123", "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 123.45, - "redirect_code": 123, + "redirect_code": 987, "related_products": [ProductInterface], "relative_url": "xyz789", "review_count": 987, @@ -6948,9 +6952,9 @@ Defines a product that the shopper downloads. "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "abc123", + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", "staged": false, "stock_status": "IN_STOCK", "swatch_image": "xyz789", @@ -6960,12 +6964,12 @@ Defines a product that the shopper downloads. "type": "CMS_PAGE", "type_id": "abc123", "uid": "4", - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "xyz789", - "url_path": "abc123", + "url_path": "xyz789", "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", + "url_suffix": "xyz789", "websites": [Website] } ``` @@ -7006,31 +7010,31 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](types-a-b.md#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price of the downloadable product. | +| `sample_file` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | +| `sample_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { - "id": 987, - "is_shareable": false, + "id": 123, + "is_shareable": true, "link_type": "FILE", "number_of_downloads": 987, - "price": 123.45, + "price": 987.65, "sample_file": "abc123", "sample_type": "FILE", - "sample_url": "abc123", - "sort_order": 987, + "sample_url": "xyz789", + "sort_order": 123, "title": "abc123", "uid": 4 } @@ -7046,7 +7050,7 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example @@ -7064,23 +7068,23 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `id` - [`Int`](types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](types-q-s.md#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | +| `sample_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the sample. | #### Example ```json { - "id": 123, - "sample_file": "xyz789", + "id": 987, + "sample_file": "abc123", "sample_type": "FILE", "sample_url": "abc123", - "sort_order": 123, - "title": "xyz789" + "sort_order": 987, + "title": "abc123" } ``` @@ -7094,12 +7098,12 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of the product added to the requisition list. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -7110,7 +7114,7 @@ Contains details about downloadable products added to a requisition list. "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -7124,26 +7128,26 @@ A downloadable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `added_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | | `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples] } ``` @@ -7158,14 +7162,14 @@ Identifies a quote to be duplicated | Input Field | Description | |-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | +| `duplicated_quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | ID of the quote to be duplicated. | #### Example ```json { - "duplicated_quote_uid": 4, + "duplicated_quote_uid": "4", "quote_uid": "4" } ``` @@ -7180,7 +7184,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -7199,15 +7203,12 @@ Contains a single dynamic block. | Field Name | Description | |------------|-------------| | `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json -{ - "content": ComplexTextValue, - "uid": "4" -} +{"content": ComplexTextValue, "uid": 4} ``` @@ -7263,8 +7264,8 @@ Contains an array of dynamic blocks. | Field Name | Description | |------------|-------------| | `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of returned dynamic blocks. | #### Example @@ -7272,7 +7273,7 @@ Contains an array of dynamic blocks. { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -7286,18 +7287,14 @@ Defines the dynamic block filter. The filter can identify the block type, locati | Input Field | Description | |-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](types-f-i.md#id) | An array of dynamic block UIDs to filter on. | +| `dynamic_block_uids` - [`[ID]`](/reference/graphql/latest/types-f-i.md#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" -} +{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"} ``` @@ -7310,15 +7307,15 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | +| `attribute_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The text or other entered value. | #### Example ```json { "attribute_code": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -7332,15 +7329,15 @@ Defines a customer-entered option. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Text the customer entered. | #### Example ```json { "uid": "4", - "value": "xyz789" + "value": "abc123" } ``` @@ -7354,21 +7351,21 @@ Contains the `uid`, `relative_url`, and `type` attributes. | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](types-f-i.md#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`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "canonical_url": "xyz789", - "entity_uid": 4, - "id": 987, - "redirectCode": 123, + "canonical_url": "abc123", + "entity_uid": "4", + "id": 123, + "redirectCode": 987, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -7385,14 +7382,14 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | #### Possible Types | Error Types | |----------------| | [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](types-f-i.md#insufficientstockerror) | +| [`InsufficientStockError`](/reference/graphql/latest/types-f-i.md#insufficientstockerror) | #### Example @@ -7411,15 +7408,15 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/latest/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/latest/types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/latest/types-k-p.md#negotiablequoteinvalidstateerror) | #### Example @@ -7438,7 +7435,7 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -7446,7 +7443,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput } ``` @@ -7460,8 +7457,8 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](/reference/graphql/latest/types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example @@ -7520,14 +7517,14 @@ Contains customer token for external customer. | Field Name | Description | |------------|-------------| | `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | -| `token` - [`String!`](types-q-s.md#string) | The customer authorization token. | +| `token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The customer authorization token. | #### Example ```json { "customer": Customer, - "token": "abc123" + "token": "xyz789" } ``` @@ -7541,13 +7538,13 @@ Lists the exchange rate. | Field Name | Description | |------------|-------------| -| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | +| `currency_to` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "abc123", "rate": 987.65} +{"currency_to": "abc123", "rate": 123.45} ``` @@ -7560,7 +7557,7 @@ Assigns a specific `cart_id` to the empty cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](types-q-s.md#string) | The ID to assign to the cart. | +| `cart_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ID to assign to the cart. | #### 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 32ff0d1b3..17dfa552b 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 @@ -6,27 +6,27 @@ | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/latest/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/latest/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "code": "abc123", - "is_visible": false, + "code": "xyz789", + "is_visible": true, "payment_intent": "abc123", "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "three_ds_mode": "OFF", - "title": "abc123" + "title": "xyz789" } ``` @@ -40,15 +40,15 @@ Fastlane Payment inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `paypal_fastlane_token` - [`String`](types-q-s.md#string) | The single use token from Fastlane | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `paypal_fastlane_token` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The single use token from Fastlane | #### Example ```json { - "payment_source": "abc123", - "paypal_fastlane_token": "abc123" + "payment_source": "xyz789", + "paypal_fastlane_token": "xyz789" } ``` @@ -62,15 +62,15 @@ Defines a filter that matches the input exactly. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"]`. | +| `eq` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](/reference/graphql/latest/types-q-s.md#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"] + "eq": "abc123", + "in": ["xyz789"] } ``` @@ -101,13 +101,13 @@ Defines a filter that performs a fuzzy search. | Input Field | Description | |-------------|-------------| -| `match` - [`String`](types-q-s.md#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` - [`String`](/reference/graphql/latest/types-q-s.md#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"} +{"match": "abc123", "match_type": "FULL"} ``` @@ -120,14 +120,14 @@ Defines a filter that matches a range of values, such as prices or dates. | Input Field | Description | |-------------|-------------| -| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | +| `from` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example ```json { - "from": "xyz789", + "from": "abc123", "to": "xyz789" } ``` @@ -142,16 +142,16 @@ Defines a filter for an input string. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | +| `eq` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example ```json { "eq": "abc123", - "in": ["xyz789"], + "in": ["abc123"], "match": "xyz789" } ``` @@ -166,41 +166,41 @@ Defines the comparison operators that can be used in a filter. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Equals. | -| `finset` - [`[String]`](types-q-s.md#string) | | -| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](types-q-s.md#string) | Greater than. | -| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | -| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](types-q-s.md#string) | Less than. | -| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | -| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | -| `neq` - [`String`](types-q-s.md#string) | Not equal to. | -| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](types-q-s.md#string) | Not null. | -| `null` - [`String`](types-q-s.md#string) | Is null. | -| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | +| `eq` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Equals. | +| `finset` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | | +| `from` - [`String`](/reference/graphql/latest/types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Less than. | +| `lteq` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](/reference/graphql/latest/types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Not null. | +| `null` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Is null. | +| `to` - [`String`](/reference/graphql/latest/types-q-s.md#string) | To. Must be used with the `from` field. | #### Example ```json { "eq": "abc123", - "finset": ["abc123"], - "from": "xyz789", - "gt": "abc123", - "gteq": "xyz789", + "finset": ["xyz789"], + "from": "abc123", + "gt": "xyz789", + "gteq": "abc123", "in": ["xyz789"], - "like": "xyz789", + "like": "abc123", "lt": "abc123", - "lteq": "abc123", + "lteq": "xyz789", "moreq": "abc123", - "neq": "xyz789", + "neq": "abc123", "nin": ["abc123"], "notnull": "abc123", - "null": "xyz789", - "to": "abc123" + "null": "abc123", + "to": "xyz789" } ``` @@ -214,8 +214,8 @@ A single FPT that can be applied to a product price. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | +| `amount` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example @@ -272,7 +272,7 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example @@ -290,12 +290,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | +| `customer_token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "abc123"} +{"customer_token": "xyz789"} ``` @@ -313,7 +313,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -344,7 +344,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](/reference/graphql/latest/types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -362,17 +362,17 @@ Contains details about the gift card account. | Field Name | Description | |------------|-------------| -| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `balance` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The expiration date of the gift card. | #### Example ```json { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } ``` @@ -386,7 +386,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The applied gift card code. | #### Example @@ -416,8 +416,8 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { "attribute_id": 987, - "uid": 4, - "value": 123.45, + "uid": "4", + "value": 987.65, "value_id": 987, "website_id": 123, "website_value": 987.65 @@ -434,28 +434,28 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount and currency of the gift card. | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#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]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/latest/types-c-e.md#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!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-q-s.md#string) | The message from the sender to the recipient. | +| `message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The message from the sender to the recipient. | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | +| `prices` - [`CartItemPrices`](/reference/graphql/latest/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about an item in the cart. | | `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | -| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `recipient_email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -472,7 +472,7 @@ Contains details about a gift card that has been added to a cart. "id": "xyz789", "is_available": true, "max_qty": 123.45, - "message": "abc123", + "message": "xyz789", "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], @@ -480,11 +480,11 @@ Contains details about a gift card that has been added to a cart. "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "recipient_email": "xyz789", + "recipient_email": "abc123", "recipient_name": "abc123", - "sender_email": "abc123", - "sender_name": "xyz789", - "uid": 4 + "sender_email": "xyz789", + "sender_name": "abc123", + "uid": "4" } ``` @@ -496,13 +496,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#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`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -515,8 +515,8 @@ Contains details about a gift card that has been added to a cart. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 + "product_sku": "abc123", + "quantity_refunded": 987.65 } ``` @@ -528,13 +528,13 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -543,12 +543,12 @@ Contains details about a gift card that has been added to a cart. { "discounts": [Discount], "gift_card": GiftCardItem, - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -562,21 +562,21 @@ Contains details about a gift card. | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | +| `message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example ```json { - "message": "xyz789", + "message": "abc123", "recipient_email": "xyz789", - "recipient_name": "xyz789", + "recipient_name": "abc123", "sender_email": "abc123", - "sender_name": "abc123" + "sender_name": "xyz789" } ``` @@ -590,13 +590,13 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | +| `amount` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -605,9 +605,9 @@ Contains details about the sender, recipient, and amount of a gift card. "amount": Money, "custom_giftcard_amount": Money, "message": "abc123", - "recipient_email": "xyz789", - "recipient_name": "abc123", - "sender_email": "xyz789", + "recipient_email": "abc123", + "recipient_name": "xyz789", + "sender_email": "abc123", "sender_name": "xyz789" } ``` @@ -620,20 +620,20 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#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`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/latest/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/latest/types-q-s.md#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. | @@ -641,8 +641,8 @@ Contains details about the sender, recipient, and amount of a gift card. | `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]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/latest/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the order item. | #### Example @@ -659,18 +659,18 @@ Contains details about the sender, recipient, and amount of a gift card. "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 123.45, + "product_url_key": "abc123", + "quantity_canceled": 987.65, "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 123.45, - "quantity_return_requested": 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" + "status": "abc123" } ``` @@ -684,121 +684,121 @@ Defines properties of a gift card. | Field Name | Description | |------------|-------------| -| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](types-a-b.md#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `allow_message` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](/reference/graphql/latest/types-c-e.md#categoryinterface) | The categories assigned to a product. | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `country_of_manufacture` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/latest/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](/reference/graphql/latest/types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/latest/types-k-p.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/latest/types-k-p.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/latest/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/latest/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/latest/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/latest/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/latest/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/latest/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/latest/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/latest/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/latest/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/latest/types-t-z.md#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_message": true, "allow_open_amount": true, "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], - "color": 123, + "color": 987, "country_of_manufacture": "abc123", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": true, - "gift_wrapping_available": false, + "gift_message_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", - "id": 123, + "id": 987, "image": ProductImage, "is_redeemable": false, "is_returnable": "abc123", - "lifetime": 987, - "manufacturer": 123, - "max_sale_qty": 123.45, + "lifetime": 123, + "manufacturer": 987, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "message_max_length": 987, "meta_description": "abc123", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "xyz789", - "min_sale_qty": 987.65, + "min_sale_qty": 123.45, "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "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, + "open_amount_min": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", "price": ProductPrices, @@ -809,7 +809,7 @@ Defines properties of a gift card. "rating_summary": 123.45, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, @@ -817,24 +817,24 @@ Defines properties of a gift card. "small_image": ProductImage, "special_from_date": "abc123", "special_price": 123.45, - "special_to_date": "abc123", - "staged": false, + "special_to_date": "xyz789", + "staged": true, "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "abc123", + "type_id": "xyz789", "uid": "4", - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "xyz789", "url_rewrites": [UrlRewrite], "url_suffix": "abc123", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -848,9 +848,9 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a requisition list item. | | `quantity` - [`Float!`](#float) | The amount added. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | @@ -861,8 +861,8 @@ Contains details about gift cards added to a requisition list. "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` @@ -876,10 +876,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -887,11 +887,11 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_shipped": 123.45 } ``` @@ -926,12 +926,12 @@ A single gift card added to a wish list. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -959,15 +959,12 @@ Gift card custom attribute value containing array data. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The attribute code. | -| `options` - [`[String]!`](types-q-s.md#string) | Array of gift card attribute option values. | +| `options` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | Array of gift card attribute option values. | #### Example ```json -{ - "code": "4", - "options": ["abc123"] -} +{"code": 4, "options": ["abc123"]} ``` @@ -980,17 +977,17 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | Sender name | -| `message` - [`String!`](types-q-s.md#string) | Gift message text | -| `to` - [`String!`](types-q-s.md#string) | Recipient name | +| `from` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Sender name | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Gift message text | +| `to` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "xyz789", + "from": "abc123", "message": "abc123", - "to": "abc123" + "to": "xyz789" } ``` @@ -1004,9 +1001,9 @@ Defines a gift message. | Input Field | Description | |-------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | -| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | -| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | +| `from` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the recepient. | #### Example @@ -1028,12 +1025,12 @@ Contains prices for gift wrapping options. | Field Name | Description | |------------|-------------| -| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_items_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | -| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | -| `gift_wrapping_for_order_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | -| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | -| `printed_card_incl_tax` - [`Money`](types-k-p.md#money) | Price for the printed card including tax. | +| `gift_wrapping_for_items` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Price for the printed card including tax. | #### Example @@ -1058,15 +1055,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](types-q-s.md#string) | The name of the event. | +| `event_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the event. | | `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](types-q-s.md#string) | The customer who created the gift registry. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](/reference/graphql/latest/types-q-s.md#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`](types-c-e.md#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `shipping_address` - [`CustomerAddress`](/reference/graphql/latest/types-c-e.md#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. | @@ -1079,14 +1076,14 @@ Contains details about a gift registry. "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 } ``` @@ -1100,16 +1097,16 @@ Contains details about a gift registry. |------------|-------------| | `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!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": 4, + "code": "4", "group": "EVENT_INFORMATION", - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -1148,12 +1145,12 @@ Defines a dynamic attribute. | Input Field | Description | |-------------|-------------| | `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example ```json -{"code": 4, "value": "xyz789"} +{"code": 4, "value": "abc123"} ``` @@ -1165,8 +1162,8 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1179,9 +1176,9 @@ Defines a dynamic attribute. ```json { - "code": "4", + "code": 4, "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -1193,21 +1190,21 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#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, + "attribute_group": "abc123", + "code": "4", + "input_type": "abc123", + "is_required": false, "label": "xyz789", "sort_order": 987 } @@ -1221,11 +1218,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1243,7 +1240,7 @@ Defines a dynamic attribute. "input_type": "abc123", "is_required": true, "label": "abc123", - "sort_order": 987 + "sort_order": 123 } ``` @@ -1255,9 +1252,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#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. | @@ -1266,12 +1263,12 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", - "note": "abc123", + "created_at": "xyz789", + "note": "xyz789", "product": ProductInterface, "quantity": 123.45, "quantity_fulfilled": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -1283,9 +1280,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the gift registry item. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#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. | @@ -1300,10 +1297,10 @@ Defines a dynamic attribute. ```json { - "created_at": "xyz789", - "note": "abc123", + "created_at": "abc123", + "note": "xyz789", "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "quantity_fulfilled": 123.45, "uid": 4 } @@ -1319,14 +1316,14 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/latest/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1350,7 +1347,7 @@ Contains details about an error that occurred when processing a gift registry it | `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!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1360,7 +1357,7 @@ Contains details about an error that occurred when processing a gift registry it "code": "OUT_OF_STOCK", "gift_registry_item_uid": "4", "gift_registry_uid": 4, - "message": "xyz789", + "message": "abc123", "product_uid": 4 } ``` @@ -1401,7 +1398,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/latest/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1439,9 +1436,9 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1452,9 +1449,9 @@ Contains details about a registrant. GiftRegistryRegistrantDynamicAttribute ], "email": "xyz789", - "firstname": "xyz789", - "lastname": "xyz789", - "uid": "4" + "firstname": "abc123", + "lastname": "abc123", + "uid": 4 } ``` @@ -1467,16 +1464,16 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": "4", + "code": 4, "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1490,23 +1487,23 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | -| `event_title` - [`String!`](types-q-s.md#string) | The title given to the event. | +| `event_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The title given to the event. | | `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](types-q-s.md#string) | The location of the event. | -| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | -| `type` - [`String`](types-q-s.md#string) | The type of event being held. | +| `location` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of event being held. | #### Example ```json { - "event_date": "abc123", - "event_title": "xyz789", - "gift_registry_uid": "4", + "event_date": "xyz789", + "event_title": "abc123", + "gift_registry_uid": 4, "location": "xyz789", "name": "abc123", - "type": "abc123" + "type": "xyz789" } ``` @@ -1520,7 +1517,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](/reference/graphql/latest/types-c-e.md#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. | @@ -1530,7 +1527,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or { "address_data": CustomerAddressInput, "address_id": 4, - "customer_address_uid": 4 + "customer_address_uid": "4" } ``` @@ -1564,7 +1561,7 @@ Contains details about a gift registry type. | 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!`](types-q-s.md#string) | The label assigned to the gift registry type on the Admin. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#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 @@ -1575,7 +1572,7 @@ Contains details about a gift registry type. GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1589,21 +1586,21 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](types-q-s.md#string) | The name of the gift wrapping design. | +| `design` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](types-k-p.md#money) | The gift wrapping price. | +| `price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example ```json { - "design": "xyz789", - "id": "4", + "design": "abc123", + "id": 4, "image": GiftWrappingImage, "price": Money, - "uid": "4" + "uid": 4 } ``` @@ -1617,8 +1614,8 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | -| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The gift wrapping preview image URL. | #### Example @@ -1637,9 +1634,9 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | +| `color` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](types-q-s.md#string) | The button type | +| `type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The button type | #### Example @@ -1660,26 +1657,26 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| | `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/latest/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/latest/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": GooglePayButtonStyles, - "code": "abc123", + "code": "xyz789", "is_visible": false, "payment_intent": "xyz789", "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds_mode": "OFF", "title": "xyz789" } @@ -1695,16 +1692,16 @@ Google Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | #### Example ```json { "payment_source": "xyz789", - "payments_order_id": "abc123", + "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } ``` @@ -1720,67 +1717,67 @@ Defines a grouped product, which consists of simple standalone products that are | 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`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](/reference/graphql/latest/types-c-e.md#categoryinterface) | The categories assigned to a product. | | `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `country_of_manufacture` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/latest/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/latest/types-k-p.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/latest/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for new product listings. | | `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `options_container` - [`String`](/reference/graphql/latest/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/latest/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/latest/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/latest/types-k-p.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/latest/types-q-s.md#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!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/latest/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `tier_prices` - [`[ProductTierPrices]`](/reference/graphql/latest/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/latest/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/latest/types-t-z.md#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 @@ -1788,61 +1785,61 @@ Defines a grouped product, which consists of simple standalone products that are ```json { "attribute_set_id": 123, - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "color": 987, - "country_of_manufacture": "abc123", - "created_at": "abc123", + "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_available": true, "gift_wrapping_price": Money, "id": 123, "image": ProductImage, "is_returnable": "xyz789", "items": [GroupedProductItem], - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "abc123", + "meta_description": "abc123", + "meta_keyword": "xyz789", "meta_title": "xyz789", "min_sale_qty": 987.65, "name": "xyz789", "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "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": 123.45, - "redirect_code": 987, + "rating_summary": 987.65, + "redirect_code": 123, "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, + "relative_url": "xyz789", + "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_from_date": "abc123", "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, + "special_to_date": "xyz789", + "staged": false, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", "type_id": "xyz789", - "uid": "4", - "updated_at": "xyz789", + "uid": 4, + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "xyz789", "url_path": "abc123", @@ -1864,14 +1861,14 @@ Contains information about an individual grouped product item. | Field Name | Description | |------------|-------------| | `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about this product option. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about this product option. | | `qty` - [`Float`](#float) | The quantity of this grouped product item. | #### Example ```json { - "position": 123, + "position": 987, "product": ProductInterface, "qty": 987.65 } @@ -1887,11 +1884,11 @@ A grouped product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The description of the item. | | `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example @@ -1900,8 +1897,8 @@ A grouped product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, + "description": "xyz789", + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -1917,15 +1914,15 @@ Input to retrieve a guest order based on token. | Input Field | Description | |-------------|-------------| -| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | -| `token` - [`String!`](types-q-s.md#string) | Order token. | +| `reason` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Cancellation reason. | +| `token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Order token. | #### Example ```json { "reason": "abc123", - "token": "xyz789" + "token": "abc123" } ``` @@ -1939,17 +1936,17 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | -| `lastname` - [`String!`](types-q-s.md#string) | Order billing address lastname. | -| `number` - [`String!`](types-q-s.md#string) | Order number. | +| `email` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Order billing address email. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Order billing address lastname. | +| `number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Order number. | #### Example ```json { "email": "xyz789", - "lastname": "abc123", - "number": "xyz789" + "lastname": "xyz789", + "number": "abc123" } ``` @@ -1961,32 +1958,32 @@ Input to retrieve an order based on details. | Field Name | Description | |------------|-------------| -| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds` - [`Boolean`](types-a-b.md#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `cc_vault_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/latest/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/latest/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "cc_vault_code": "abc123", + "cc_vault_code": "xyz789", "code": "abc123", "is_vault_enabled": false, "is_visible": true, - "payment_intent": "xyz789", + "payment_intent": "abc123", "payment_source": "xyz789", "requires_card_details": false, "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds": false, "three_ds_mode": "OFF", "title": "abc123" @@ -2003,28 +2000,28 @@ Hosted Fields payment inputs | Input Field | Description | |-------------|-------------| -| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | -| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `holderName` - [`String`](types-q-s.md#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `cardBin` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | #### Example ```json { - "cardBin": "xyz789", + "cardBin": "abc123", "cardExpiryMonth": "xyz789", "cardExpiryYear": "xyz789", - "cardLast4": "xyz789", + "cardLast4": "abc123", "holderName": "abc123", "is_active_payment_token_enabler": false, - "payment_source": "abc123", - "payments_order_id": "abc123", + "payment_source": "xyz789", + "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } ``` @@ -2039,14 +2036,14 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](/reference/graphql/latest/types-q-s.md#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", + "cancel_url": "abc123", "return_url": "abc123" } ``` @@ -2061,12 +2058,12 @@ Contains the secure URL used for the Payments Pro Hosted Solution payment method | Field Name | Description | |------------|-------------| -| `secure_form_url` - [`String`](types-q-s.md#string) | The secure URL generated by PayPal. | +| `secure_form_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The secure URL generated by PayPal. | #### Example ```json -{"secure_form_url": "abc123"} +{"secure_form_url": "xyz789"} ``` @@ -2079,12 +2076,12 @@ Contains the required input to request the secure URL for Payments Pro Hosted So | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -2097,15 +2094,15 @@ Contains target path parameters. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | A parameter name. | -| `value` - [`String`](types-q-s.md#string) | A parameter value. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A parameter name. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A parameter value. | #### Example ```json { "name": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -2122,7 +2119,7 @@ When expected as an input type, any string (such as `"4"`) or integer #### Example ```json -"4" +4 ``` @@ -2133,15 +2130,15 @@ When expected as an input type, any string (such as `"4"`) or integer | Field Name | Description | |------------|-------------| -| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `thumbnail` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json { "thumbnail": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -2175,8 +2172,8 @@ List of templates/filters applied to customer attribute input. | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `code` - [`CartUserInputErrorType!`](/reference/graphql/latest/types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | | `quantity` - [`Float`](#float) | Amount of available stock | #### Example @@ -2184,7 +2181,7 @@ List of templates/filters applied to customer attribute input. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", + "message": "abc123", "quantity": 987.65 } ``` @@ -2199,7 +2196,7 @@ values. Int can represent values between -(2^31) and 2^31 - 1. #### Example ```json -123 +987 ``` @@ -2212,12 +2209,12 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -2230,10 +2227,10 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the invoice. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/latest/types-q-s.md#salescommentitem) | Comments on the invoice. | | `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | | `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](types-q-s.md#string) | Sequential invoice number. | +| `number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2241,9 +2238,9 @@ Contains invoice details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [InvoiceItemInterface], - "number": "abc123", + "number": "xyz789", "total": InvoiceTotal } ``` @@ -2256,12 +2253,12 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2269,12 +2266,12 @@ Contains invoice details. ```json { "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 + "product_sku": "xyz789", + "quantity_invoiced": 987.65 } ``` @@ -2288,20 +2285,20 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](/reference/graphql/latest/types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](/reference/graphql/latest/types-a-b.md#bundleinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2315,7 +2312,7 @@ Contains detailes about invoiced items. "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -2329,14 +2326,14 @@ Contains price details from an invoice. | Field Name | Description | |------------|-------------| -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | +| `base_grand_total` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/latest/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/latest/types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2363,7 +2360,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2381,7 +2378,7 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example @@ -2399,7 +2396,7 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example @@ -2417,7 +2414,7 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example @@ -2435,12 +2432,12 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2453,18 +2450,18 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](types-q-s.md#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | Note text. | +| `note` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example ```json { - "created_at": "xyz789", + "created_at": "abc123", "creator_id": 123, "creator_type": 987, "negotiable_quote_item_uid": "4", @@ -2484,7 +2481,7 @@ A list of options of the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](types-q-s.md#string) | The label of the option. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#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. | @@ -2494,7 +2491,7 @@ A list of options of the selected bundle product. { "id": 4, "label": "xyz789", - "uid": 4, + "uid": "4", "values": [ItemSelectedBundleOptionValue] } ``` @@ -2510,9 +2507,9 @@ A list of values for the selected bundle product. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | -| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the child bundle product. | +| `price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#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. | @@ -2524,8 +2521,8 @@ A list of values for the selected bundle product. "price": Money, "product_name": "abc123", "product_sku": "abc123", - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md index f4c849074..bc75a7064 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md @@ -8,15 +8,15 @@ Contains a key-value pair. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | -| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value part of the key/value pair. | #### Example ```json { "name": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -31,17 +31,17 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| | `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](types-q-s.md#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | +| `filter_items_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](/reference/graphql/latest/types-q-s.md#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", + "filter_items_count": 987, + "name": "xyz789", "request_var": "xyz789" } ``` @@ -54,9 +54,9 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example @@ -76,24 +76,24 @@ Contains information for rendering layered navigation. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](types-q-s.md#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `items_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#swatchlayerfilteritem) | +| [`SwatchLayerFilterItem`](/reference/graphql/latest/types-q-s.md#swatchlayerfilteritem) | #### Example ```json { - "items_count": 987, + "items_count": 123, "label": "xyz789", - "value_string": "xyz789" + "value_string": "abc123" } ``` @@ -107,9 +107,9 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `note` - [`String`](types-q-s.md#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `note` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -132,14 +132,14 @@ Defines characteristics about images and videos associated with a specific produ | Field Name | Description | |------------|-------------| | `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](types-q-s.md#string) | The path of the image on the server. | -| `id` - [`Int`](types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](types-q-s.md#string) | Either `image` or `video`. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | +| `disabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The path of the image on the server. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Either `image` or `video`. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `MediaGalleryEntry` object. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example @@ -147,13 +147,13 @@ Defines characteristics about images and videos associated with a specific produ ```json { "content": ProductMediaGalleryEntriesContent, - "disabled": false, - "file": "xyz789", + "disabled": true, + "file": "abc123", "id": 987, "label": "abc123", - "media_type": "abc123", + "media_type": "xyz789", "position": 987, - "types": ["xyz789"], + "types": ["abc123"], "uid": "4", "video_content": ProductMediaGalleryEntriesVideoContent } @@ -169,11 +169,11 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL of the product image or video. | #### Possible Types @@ -186,8 +186,8 @@ Contains basic information about a product image or video. ```json { - "disabled": true, - "label": "xyz789", + "disabled": false, + "label": "abc123", "position": 123, "types": ["abc123"], "url": "xyz789" @@ -202,7 +202,7 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example @@ -218,14 +218,14 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `layout` - [`String`](types-q-s.md#string) | The message layout | +| `layout` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "layout": "abc123", + "layout": "xyz789", "logo": MessageStyleLogo } ``` @@ -240,8 +240,8 @@ Defines a monetary value, including a numeric value and a currency code. | Field Name | Description | |------------|-------------| -| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | +| `currency` - [`CurrencyEnum`](/reference/graphql/latest/types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | A number expressing a monetary value. | #### Example @@ -259,9 +259,9 @@ Contains the customer's gift registry and any errors encountered. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](/reference/graphql/latest/types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example @@ -283,12 +283,12 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": [4]} +{"requisitionListItemUids": ["4"]} ``` @@ -301,8 +301,8 @@ Output of the request to move items to another requisition list. | Field Name | Description | |------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | +| `destination_requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -323,16 +323,16 @@ Move Line Item to Requisition List. | Input Field | Description | |-------------|-------------| -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | +| `quote_item_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json { - "quote_item_uid": "4", - "quote_uid": "4", + "quote_item_uid": 4, + "quote_uid": 4, "requisition_list_uid": "4" } ``` @@ -365,9 +365,9 @@ Contains the source and target wish lists after moving products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/latest/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -389,23 +389,23 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/latest/types-a-b.md#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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](types-q-s.md#string) | The email address of the company user. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `is_virtual` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/latest/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](/reference/graphql/latest/types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/latest/types-q-s.md#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!`](types-f-i.md#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | +| `total_quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -418,9 +418,9 @@ Contains details about a negotiable quote. "created_at": "xyz789", "email": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], @@ -441,15 +441,15 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The address country code. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The address country code. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display name of the region. | #### Example ```json { - "code": "xyz789", - "label": "xyz789" + "code": "abc123", + "label": "abc123" } ``` @@ -463,17 +463,17 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company name. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The telephone number for the billing or shipping address. | #### Example @@ -481,12 +481,12 @@ Defines the billing or shipping address to be applied to the cart. { "city": "abc123", "company": "abc123", - "country_code": "xyz789", - "firstname": "abc123", - "lastname": "abc123", + "country_code": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", "postcode": "abc123", "region": "xyz789", - "region_id": 987, + "region_id": 123, "save_in_address_book": true, "street": ["abc123"], "telephone": "xyz789" @@ -501,15 +501,15 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's telephone number. | #### Possible Types @@ -525,12 +525,12 @@ Defines the billing or shipping address to be applied to the cart. "city": "abc123", "company": "abc123", "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "postcode": "xyz789", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -544,17 +544,17 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The address region code. | -| `label` - [`String`](types-q-s.md#string) | The display name of the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The address region code. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { "code": "abc123", - "label": "abc123", - "region_id": 123 + "label": "xyz789", + "region_id": 987 } ``` @@ -566,25 +566,25 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company's ZIP or postal code. | | `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's telephone number. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "abc123", "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["abc123"], @@ -603,17 +603,17 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](/reference/graphql/latest/types-a-b.md#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, + "customer_address_uid": "4", + "same_as_shipping": false, "use_for_shipping": true } ``` @@ -629,20 +629,20 @@ Contains a single plain text comment from either the buyer or seller. | Field Name | Description | |------------|-------------| | `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the comment was created. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the comment was created. | | `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | +| `text` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { "author": NegotiableQuoteUser, - "created_at": "abc123", + "created_at": "xyz789", "creator_type": "BUYER", "text": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -673,7 +673,7 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | +| `comment` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The comment provided by the buyer. | #### Example @@ -691,17 +691,17 @@ Contains custom log entries added by third-party extensions. | Field Name | Description | |------------|-------------| -| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | -| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | -| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | +| `new_value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { - "new_value": "abc123", - "old_value": "xyz789", - "title": "abc123" + "new_value": "xyz789", + "old_value": "abc123", + "title": "xyz789" } ``` @@ -715,8 +715,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/latest/types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -767,12 +767,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "xyz789"} +{"comment": "abc123"} ``` @@ -788,8 +788,8 @@ Contains details about a change for a negotiable quote. | `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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -832,14 +832,14 @@ Contains a new expiration date and the previous date. | Field Name | Description | |------------|-------------| -| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | +| `new_expiration` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "new_expiration": "xyz789", + "new_expiration": "abc123", "old_expiration": "abc123" } ``` @@ -854,7 +854,7 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](/reference/graphql/latest/types-f-i.md#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 @@ -935,12 +935,12 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -953,13 +953,13 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -{"quantity": 987.65, "quote_item_uid": 4} +{"quantity": 123.45, "quote_item_uid": 4} ``` @@ -972,15 +972,15 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | Payment method code | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { "code": "xyz789", - "purchase_order_number": "xyz789" + "purchase_order_number": "abc123" } ``` @@ -994,19 +994,19 @@ Contains a reference document link for a negotiable quote template. | Field Name | Description | |------------|-------------| -| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | -| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | -| `link_id` - [`ID!`](types-f-i.md#id) | The unique ID of a reference document link. | -| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | +| `document_identifier` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The URL of the reference document. | #### Example ```json { - "document_identifier": "xyz789", - "document_name": "abc123", + "document_identifier": "abc123", + "document_name": "xyz789", "link_id": 4, - "reference_document_url": "abc123" + "reference_document_url": "xyz789" } ``` @@ -1018,17 +1018,17 @@ Contains a reference document link for a negotiable quote template. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/latest/types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The last name of the company user. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | +| `selected_shipping_method` - [`SelectedShippingMethod`](/reference/graphql/latest/types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's telephone number. | #### Example @@ -1036,15 +1036,15 @@ Contains a reference document link for a negotiable quote template. { "available_shipping_methods": [AvailableShippingMethod], "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "firstname": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "postcode": "abc123", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, "street": ["xyz789"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1059,15 +1059,15 @@ Defines shipping addresses for the negotiable quote. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", + "customer_address_uid": 4, "customer_notes": "abc123" } ``` @@ -1082,7 +1082,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/latest/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1145,21 +1145,21 @@ Contains details about a negotiable quote template. |------------|-------------| | `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!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `expiration_date` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/latest/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](/reference/graphql/latest/types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](/reference/graphql/latest/types-c-e.md#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!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | +| `status` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The total number of items in the negotiable quote template. | #### Example @@ -1167,7 +1167,7 @@ Contains details about a negotiable quote template. { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, "is_virtual": false, @@ -1183,7 +1183,7 @@ Contains details about a negotiable quote template. "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "xyz789", "template_id": 4, - "total_quantity": 123.45 + "total_quantity": 987.65 } ``` @@ -1197,8 +1197,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | +| `state` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1219,41 +1219,41 @@ Contains data for a negotiable quote template in a grid. | Field Name | Description | |------------|-------------| -| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | -| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | -| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | -| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | -| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `activated_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "activated_at": "abc123", - "company_name": "xyz789", + "company_name": "abc123", "expiration_date": "abc123", "is_min_max_qty_used": true, "last_shared_at": "xyz789", - "max_order_commitment": 987, + "max_order_commitment": 123, "min_negotiated_grand_total": 987.65, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "orders_placed": 987, - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "state": "abc123", - "status": "abc123", - "submitted_by": "abc123", - "template_id": "4" + "status": "xyz789", + "submitted_by": "xyz789", + "template_id": 4 } ``` @@ -1267,20 +1267,15 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `item_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-f-i.md#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!`](/reference/graphql/latest/types-f-i.md#float) | The new quantity of the negotiable quote item. | #### Example ```json -{ - "item_id": "4", - "max_qty": 123.45, - "min_qty": 123.45, - "quantity": 987.65 -} +{"item_id": 4, "max_qty": 987.65, "min_qty": 123.45, "quantity": 987.65} ``` @@ -1293,18 +1288,18 @@ Defines the reference document link to add to a negotiable quote template. | Input Field | Description | |-------------|-------------| -| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | -| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | -| `link_id` - [`ID`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | -| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | +| `document_identifier` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The URL of the reference document. | #### Example ```json { "document_identifier": "abc123", - "document_name": "xyz789", - "link_id": "4", + "document_name": "abc123", + "link_id": 4, "reference_document_url": "xyz789" } ``` @@ -1320,15 +1315,15 @@ Defines shipping addresses for the negotiable quote template. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Text provided by the company user. | #### Example ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", + "customer_address_uid": 4, "customer_notes": "abc123" } ``` @@ -1343,7 +1338,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/latest/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1380,9 +1375,9 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/latest/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1403,7 +1398,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1427,12 +1422,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1445,8 +1440,8 @@ A limited view of a Buyer or Seller in the negotiable quote process. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The buyer's or seller's last name. | #### Example @@ -1468,9 +1463,9 @@ Contains a list of negotiable that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/latest/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1493,16 +1488,13 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | -| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json -{ - "message": "abc123", - "uid": "4" -} +{"message": "xyz789", "uid": 4} ``` @@ -1515,7 +1507,7 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -1533,8 +1525,8 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_id` - [`String`](types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | +| `order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID for an `Order` object. | #### Example @@ -1575,41 +1567,41 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `fax` - [`String`](types-q-s.md#string) | The fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `city` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The city or town. | +| `company` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](/reference/graphql/latest/types-c-e.md#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](/reference/graphql/latest/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "abc123", "region": "xyz789", "region_id": "4", - "street": ["abc123"], - "suffix": "xyz789", + "street": ["xyz789"], + "suffix": "abc123", "telephone": "abc123", "vat_id": "abc123" } @@ -1623,20 +1615,20 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | First name of the customer | -| `lastname` - [`String`](types-q-s.md#string) | Last name of the customer | -| `middlename` - [`String`](types-q-s.md#string) | Middle name of the customer | -| `prefix` - [`String`](types-q-s.md#string) | Prefix of the customer | -| `suffix` - [`String`](types-q-s.md#string) | Suffix of the customer | +| `firstname` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | First name of the customer | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Last name of the customer | +| `middlename` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Middle name of the customer | +| `prefix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Prefix of the customer | +| `suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Suffix of the customer | #### Example ```json { - "firstname": "abc123", - "lastname": "abc123", - "middlename": "xyz789", - "prefix": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", + "prefix": "xyz789", "suffix": "abc123" } ``` @@ -1649,28 +1641,28 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the order item. | #### Example @@ -1681,20 +1673,20 @@ Contains detailed information about an order's billing and shipping addresses. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "abc123", + "product_type": "xyz789", + "product_url_key": "xyz789", "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, "quantity_refunded": 123.45, "quantity_return_requested": 123.45, - "quantity_returned": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" @@ -1711,37 +1703,37 @@ Order item details. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/latest/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`ConfigurableOrderItem`](types-c-e.md#configurableorderitem) | -| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | -| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | -| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | +| [`ConfigurableOrderItem`](/reference/graphql/latest/types-c-e.md#configurableorderitem) | +| [`DownloadableOrderItem`](/reference/graphql/latest/types-c-e.md#downloadableorderitem) | +| [`BundleOrderItem`](/reference/graphql/latest/types-a-b.md#bundleorderitem) | +| [`GiftCardOrderItem`](/reference/graphql/latest/types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -1749,7 +1741,7 @@ Order item details. ```json { "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -1761,13 +1753,13 @@ Order item details. "product_sku": "xyz789", "product_type": "xyz789", "product_url_key": "xyz789", - "quantity_canceled": 987.65, + "quantity_canceled": 123.45, "quantity_invoiced": 123.45, "quantity_ordered": 987.65, - "quantity_refunded": 987.65, + "quantity_refunded": 123.45, "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -1783,14 +1775,14 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The name of the option. | -| `value` - [`String!`](types-q-s.md#string) | The value of the option. | +| `label` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "xyz789", + "label": "abc123", "value": "abc123" } ``` @@ -1803,8 +1795,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](types-f-i.md#fixedproducttax) | | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](/reference/graphql/latest/types-f-i.md#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. | @@ -1844,16 +1836,16 @@ Contains details about the payment method used to pay for the order. | Field Name | Description | |------------|-------------| | `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | -| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example ```json { "additional_data": [KeyValue], - "name": "abc123", - "type": "abc123" + "name": "xyz789", + "type": "xyz789" } ``` @@ -1867,18 +1859,18 @@ Contains order shipment details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/latest/types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](/reference/graphql/latest/types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](/reference/graphql/latest/types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [ShipmentItemInterface], "number": "abc123", "tracking": [ShipmentTracking] @@ -1895,12 +1887,12 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](types-q-s.md#string) | Order token. | +| `token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Order token. | #### Example ```json -{"token": "xyz789"} +{"token": "abc123"} ``` @@ -1914,15 +1906,15 @@ Contains details about the sales total amounts used to calculate the final price | Field Name | Description | |------------|-------------| | `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | -| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | | +| `discounts` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the order. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/latest/types-q-s.md#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]`](types-t-z.md#taxitem) | The order tax details. | +| `taxes` - [`[TaxItem]`](/reference/graphql/latest/types-t-z.md#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. | @@ -1961,8 +1953,8 @@ Contains required input for Payflow Express Checkout payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | +| `payer_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The token returned by the createPaypalExpressToken mutation. | #### Example @@ -1983,15 +1975,15 @@ A set of relative URLs that PayPal uses in response to various actions during th | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](/reference/graphql/latest/types-q-s.md#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!`](/reference/graphql/latest/types-q-s.md#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", + "cancel_url": "xyz789", "error_url": "abc123", "return_url": "abc123" } @@ -2027,9 +2019,9 @@ Contains information used to generate PayPal iframe for transaction. Applies to | Field Name | Description | |------------|-------------| | `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](types-q-s.md#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](types-q-s.md#string) | The secure token ID generated by PayPal. | +| `paypal_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The secure token ID generated by PayPal. | #### Example @@ -2037,7 +2029,7 @@ Contains information used to generate PayPal iframe for transaction. Applies to { "mode": "TEST", "paypal_url": "xyz789", - "secure_token": "abc123", + "secure_token": "xyz789", "secure_token_id": "xyz789" } ``` @@ -2052,12 +2044,12 @@ Contains information required to fetch payment token information for the Payflow | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -2070,15 +2062,15 @@ Contains input for the Payflow Pro and Payments Pro payment methods. | Input Field | Description | |-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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. | +| `cc_details` - [`CreditCardDetailsInput!`](/reference/graphql/latest/types-c-e.md#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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 + "is_active_payment_token_enabler": true } ``` @@ -2092,15 +2084,15 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](types-q-s.md#string) | The payload returned from PayPal. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The payload returned from PayPal. | #### Example ```json { - "cart_id": "abc123", - "paypal_payload": "xyz789" + "cart_id": "xyz789", + "paypal_payload": "abc123" } ``` @@ -2112,7 +2104,7 @@ Input required to complete payment. Applies to Payflow Pro and Payments Pro paym | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart with the updated selected payment method. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart with the updated selected payment method. | #### Example @@ -2130,7 +2122,7 @@ Contains input required to fetch payment token information for the Payflow Pro a | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the shopper's cart. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID that identifies the shopper's cart. | | `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example @@ -2152,9 +2144,9 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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!`](types-q-s.md#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!`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](/reference/graphql/latest/types-q-s.md#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!`](/reference/graphql/latest/types-q-s.md#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 @@ -2176,33 +2168,33 @@ Contains payment fields that are common to all types of payment methods. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/latest/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | -| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | -| [`ApplePayConfig`](types-a-b.md#applepayconfig) | -| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | -| [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | +| [`HostedFieldsConfig`](/reference/graphql/latest/types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](/reference/graphql/latest/types-q-s.md#smartbuttonsconfig) | +| [`ApplePayConfig`](/reference/graphql/latest/types-a-b.md#applepayconfig) | +| [`GooglePayConfig`](/reference/graphql/latest/types-f-i.md#googlepayconfig) | +| [`FastlaneConfig`](/reference/graphql/latest/types-f-i.md#fastlaneconfig) | #### Example ```json { - "code": "abc123", + "code": "xyz789", "is_visible": false, - "payment_intent": "xyz789", + "payment_intent": "abc123", "sdk_params": [SDKParams], "sort_order": "abc123", - "title": "xyz789" + "title": "abc123" } ``` @@ -2216,11 +2208,11 @@ Retrieves the payment configuration for a given location | Field Name | Description | |------------|-------------| -| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | -| `fastlane` - [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | Fastlane payment method configuration | -| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | +| `apple_pay` - [`ApplePayConfig`](/reference/graphql/latest/types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `fastlane` - [`FastlaneConfig`](/reference/graphql/latest/types-f-i.md#fastlaneconfig) | Fastlane payment method configuration | +| `google_pay` - [`GooglePayConfig`](/reference/graphql/latest/types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](/reference/graphql/latest/types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](/reference/graphql/latest/types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2267,28 +2259,28 @@ Defines the payment method. | Input Field | Description | |-------------|-------------| -| `braintree` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_ach_direct_debit` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_applepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](types-a-b.md#braintreeccvaultinput) | | -| `braintree_googlepay_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `braintree_paypal` - [`BraintreeInput`](types-a-b.md#braintreeinput) | | -| `braintree_paypal_vault` - [`BraintreeVaultInput`](types-a-b.md#braintreevaultinput) | | -| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](types-f-i.md#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `braintree` - [`BraintreeInput`](/reference/graphql/latest/types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](/reference/graphql/latest/types-a-b.md#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](/reference/graphql/latest/types-a-b.md#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](/reference/graphql/latest/types-a-b.md#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](/reference/graphql/latest/types-a-b.md#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](/reference/graphql/latest/types-a-b.md#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](/reference/graphql/latest/types-a-b.md#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](/reference/graphql/latest/types-a-b.md#braintreevaultinput) | | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](/reference/graphql/latest/types-f-i.md#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`](types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](types-f-i.md#fastlanemethodinput) | Required input for fastlane | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#vaultmethodinput) | Required input for vault | +| `payflowpro_cc_vault` - [`VaultTokenInput`](/reference/graphql/latest/types-t-z.md#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](/reference/graphql/latest/types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](/reference/graphql/latest/types-f-i.md#fastlanemethodinput) | Required input for fastlane | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](/reference/graphql/latest/types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](/reference/graphql/latest/types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](/reference/graphql/latest/types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](/reference/graphql/latest/types-t-z.md#vaultmethodinput) | Required input for vault | | `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `purchase_order_number` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -2302,7 +2294,7 @@ Defines the payment method. "braintree_googlepay_vault": BraintreeVaultInput, "braintree_paypal": BraintreeInput, "braintree_paypal_vault": BraintreeVaultInput, - "code": "abc123", + "code": "xyz789", "hosted_pro": HostedProInput, "payflow_express": PayflowExpressInput, "payflow_link": PayflowLinkInput, @@ -2315,7 +2307,7 @@ Defines the payment method. "payment_services_paypal_smart_buttons": SmartButtonMethodInput, "payment_services_paypal_vault": VaultMethodInput, "paypal_express": PaypalExpressInput, - "purchase_order_number": "xyz789" + "purchase_order_number": "abc123" } ``` @@ -2329,19 +2321,19 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The order ID generated by Payment Services | | `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `status` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The status of the payment order | #### Example ```json { "id": "xyz789", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "status": "abc123" } ``` @@ -2353,8 +2345,8 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](/reference/graphql/latest/types-q-s.md#sdkparams) | The payment SDK parameters | #### Example @@ -2373,7 +2365,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | +| `card` - [`Card`](/reference/graphql/latest/types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2391,7 +2383,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](types-c-e.md#cardpaymentsourceinput) | The card payment source information | +| `card` - [`CardPaymentSourceInput!`](/reference/graphql/latest/types-c-e.md#cardpaymentsourceinput) | The card payment source information | #### Example @@ -2409,7 +2401,7 @@ The payment source information | Field Name | Description | |------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](types-c-e.md#cardpaymentsourceoutput) | The card payment source information | +| `card` - [`CardPaymentSourceOutput!`](/reference/graphql/latest/types-c-e.md#cardpaymentsourceoutput) | The card payment source information | #### Example @@ -2427,9 +2419,9 @@ The stored payment method available to the customer. | Field Name | Description | |------------|-------------| -| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | +| `details` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example @@ -2437,8 +2429,8 @@ The stored payment method available to the customer. ```json { "details": "xyz789", - "payment_method_code": "abc123", - "public_hash": "xyz789", + "payment_method_code": "xyz789", + "public_hash": "abc123", "type": "card" } ``` @@ -2472,8 +2464,8 @@ Contains required input for Express Checkout and Payments Standard payments. | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](types-q-s.md#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `payer_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example @@ -2494,11 +2486,11 @@ Defines the attributes required to receive a payment token for Express Checkout | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | -| `express_button` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The payment method code. | +| `express_button` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | +| `use_paypal_credit` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example @@ -2523,14 +2515,14 @@ Contains the token returned by PayPal and a set of URLs that allow the buyer to | Field Name | Description | |------------|-------------| | `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](types-q-s.md#string) | The token returned by PayPal. | +| `token` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The token returned by PayPal. | #### Example ```json { "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" + "token": "abc123" } ``` @@ -2544,14 +2536,14 @@ Contains a set of URLs that allow the buyer to authorize payment and adjust chec | Field Name | Description | |------------|-------------| -| `edit` - [`String`](types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](types-q-s.md#string) | The URL to the PayPal login page. | +| `edit` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL to the PayPal login page. | #### Example ```json { - "edit": "abc123", + "edit": "xyz789", "start": "xyz789" } ``` @@ -2566,17 +2558,17 @@ Contains a set of relative URLs that PayPal uses in response to various actions | Input Field | Description | |-------------|-------------| -| `cancel_url` - [`String!`](types-q-s.md#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`](types-q-s.md#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!`](types-q-s.md#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`](types-q-s.md#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. | +| `cancel_url` - [`String!`](/reference/graphql/latest/types-q-s.md#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`](/reference/graphql/latest/types-q-s.md#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!`](/reference/graphql/latest/types-q-s.md#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`](/reference/graphql/latest/types-q-s.md#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", + "cancel_url": "abc123", + "pending_url": "xyz789", "return_url": "xyz789", "success_url": "abc123" } @@ -2592,22 +2584,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Possible Types | PhysicalProductInterface Types | |----------------| -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`SimpleProduct`](/reference/graphql/latest/types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](/reference/graphql/latest/types-c-e.md#configurableproduct) | +| [`BundleProduct`](/reference/graphql/latest/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/latest/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/latest/types-f-i.md#groupedproduct) | #### Example ```json -{"weight": 123.45} +{"weight": 987.65} ``` @@ -2620,21 +2612,21 @@ Defines Pickup Location information. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | | -| `contact_name` - [`String`](types-q-s.md#string) | | -| `country_id` - [`String`](types-q-s.md#string) | | -| `description` - [`String`](types-q-s.md#string) | | -| `email` - [`String`](types-q-s.md#string) | | -| `fax` - [`String`](types-q-s.md#string) | | -| `latitude` - [`Float`](types-f-i.md#float) | | -| `longitude` - [`Float`](types-f-i.md#float) | | -| `name` - [`String`](types-q-s.md#string) | | -| `phone` - [`String`](types-q-s.md#string) | | -| `pickup_location_code` - [`String`](types-q-s.md#string) | | -| `postcode` - [`String`](types-q-s.md#string) | | -| `region` - [`String`](types-q-s.md#string) | | -| `region_id` - [`Int`](types-f-i.md#int) | | -| `street` - [`String`](types-q-s.md#string) | | +| `city` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `contact_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `country_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `email` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `fax` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `latitude` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | | +| `longitude` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `phone` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `pickup_location_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `postcode` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `region` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | +| `region_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | | +| `street` - [`String`](/reference/graphql/latest/types-q-s.md#string) | | #### Example @@ -2643,17 +2635,17 @@ Defines Pickup Location information. "city": "xyz789", "contact_name": "xyz789", "country_id": "xyz789", - "description": "xyz789", - "email": "abc123", - "fax": "xyz789", - "latitude": 123.45, - "longitude": 987.65, + "description": "abc123", + "email": "xyz789", + "fax": "abc123", + "latitude": 987.65, + "longitude": 123.45, "name": "abc123", "phone": "abc123", "pickup_location_code": "xyz789", "postcode": "xyz789", "region": "xyz789", - "region_id": 123, + "region_id": 987, "street": "abc123" } ``` @@ -2668,14 +2660,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | Input Field | Description | |-------------|-------------| -| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | +| `city` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2702,22 +2694,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | Input Field | Description | |-------------|-------------| -| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | -| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | +| `city` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#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`](/reference/graphql/latest/types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2753,8 +2745,8 @@ Top level object returned in a pickup locations search. | Field Name | Description | |------------|-------------| | `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of products returned. | #### Example @@ -2776,12 +2768,12 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -2813,14 +2805,14 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "CART_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -2854,7 +2846,7 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a purchase order. | #### Example @@ -2872,7 +2864,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](/reference/graphql/latest/types-c-e.md#customerorder) | Placed order. | #### Example @@ -2890,7 +2882,7 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2910,7 +2902,7 @@ Contains the results of the request to place an order. |------------|-------------| | `errors` - [`[PlaceOrderError]`](#placeordererror) | An array of place order errors. | | `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | -| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | +| `orderV2` - [`CustomerOrder`](/reference/graphql/latest/types-c-e.md#customerorder) | Full order information. | #### Example @@ -2932,12 +2924,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -3053,16 +3045,16 @@ Can be used to retrieve the main price details in case of bundle product | Field Name | Description | |------------|-------------| -| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | +| `discount_percentage` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The regular price of the main product | #### Example ```json { "discount_percentage": 987.65, - "main_final_price": 987.65, + "main_final_price": 123.45, "main_price": 123.45 } ``` @@ -3138,15 +3130,15 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | +| `code` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The display value of the attribute. | #### Example ```json { "code": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -3160,15 +3152,15 @@ Defines the filters to be used in the search. A filter contains at least one att | Input Field | Description | |-------------|-------------| -| `category_id` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `category_url_path` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | -| `description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Description | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | -| `price` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Attribute label: Price | -| `short_description` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | -| `sku` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Attribute label: SKU | -| `url_key` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | +| `category_id` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter product by category URL path. | +| `description` - [`FilterMatchTypeInput`](/reference/graphql/latest/types-f-i.md#filtermatchtypeinput) | Attribute label: Description | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/latest/types-f-i.md#filtermatchtypeinput) | Attribute label: Product Name | +| `price` - [`FilterRangeTypeInput`](/reference/graphql/latest/types-f-i.md#filterrangetypeinput) | Attribute label: Price | +| `short_description` - [`FilterMatchTypeInput`](/reference/graphql/latest/types-f-i.md#filtermatchtypeinput) | Attribute label: Short Description | +| `sku` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Attribute label: SKU | +| `url_key` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | The part of the URL that identifies the product | #### Example @@ -3196,10 +3188,10 @@ Specifies the attribute to use for sorting search results and indicates whether | Input Field | Description | |-------------|-------------| -| `name` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](types-q-s.md#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](types-q-s.md#sortenum) | Sort by the search relevance score (default). | +| `name` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](/reference/graphql/latest/types-q-s.md#sortenum) | Sort by the search relevance score (default). | #### Example @@ -3217,8 +3209,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](/reference/graphql/latest/types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3239,13 +3231,13 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | -| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The discount expressed a percentage. | #### Example ```json -{"amount_off": 123.45, "percent_off": 123.45} +{"amount_off": 123.45, "percent_off": 987.65} ``` @@ -3258,45 +3250,45 @@ ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. Prod | Input Field | Description | |-------------|-------------| -| `category_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `category_id` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | +| `price` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](/reference/graphql/latest/types-f-i.md#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example @@ -3354,19 +3346,19 @@ Contains product image information, including the image URL and label. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL of the product image or video. | #### Example ```json { "disabled": true, - "label": "abc123", - "position": 987, + "label": "xyz789", + "position": 123, "types": ["xyz789"], "url": "abc123" } @@ -3399,12 +3391,12 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | +| `sku` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | Product SKU. | #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -3417,109 +3409,109 @@ Contains fields that are common to all types of products. | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](/reference/graphql/latest/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `is_returnable` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/latest/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The average of all the ratings given to the product. | | `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | +| `review_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The total count of all the reviews given to the product. | | `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `special_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | | `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `swatch_image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of a swatch image. | | `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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_price` - [`Float`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `type_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#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`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](types-t-z.md#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/latest/types-t-z.md#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](/reference/graphql/latest/types-t-z.md#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`](types-t-z.md#virtualproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`VirtualProduct`](/reference/graphql/latest/types-t-z.md#virtualproduct) | +| [`SimpleProduct`](/reference/graphql/latest/types-q-s.md#simpleproduct) | +| [`ConfigurableProduct`](/reference/graphql/latest/types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](/reference/graphql/latest/types-c-e.md#downloadableproduct) | +| [`BundleProduct`](/reference/graphql/latest/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/latest/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/latest/types-f-i.md#groupedproduct) | #### Example ```json { - "attribute_set_id": 987, - "canonical_url": "xyz789", + "attribute_set_id": 123, + "canonical_url": "abc123", "categories": [CategoryInterface], "color": 123, "country_of_manufacture": "xyz789", - "created_at": "xyz789", + "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, "id": 987, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "manufacturer": 987, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "abc123", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", + "min_sale_qty": 987.65, + "name": "abc123", "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options_container": "abc123", + "only_x_left_in_stock": 123.45, + "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -3527,28 +3519,28 @@ Contains fields that are common to all types of products. "quantity": 123.45, "rating_summary": 987.65, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, + "special_from_date": "abc123", + "special_price": 123.45, "special_to_date": "abc123", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], - "type_id": "xyz789", - "uid": "4", - "updated_at": "xyz789", + "type_id": "abc123", + "uid": 4, + "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "xyz789", + "url_key": "xyz789", + "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", + "url_suffix": "abc123", "websites": [Website] } ``` @@ -3563,20 +3555,20 @@ An implementation of `ProductLinksInterface`. | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { - "link_type": "abc123", - "linked_product_sku": "abc123", + "link_type": "xyz789", + "linked_product_sku": "xyz789", "linked_product_type": "xyz789", - "position": 123, + "position": 987, "sku": "abc123" } ``` @@ -3591,11 +3583,11 @@ Contains information about linked products, including the link type and product | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3609,9 +3601,9 @@ Contains information about linked products, including the link type and product { "link_type": "abc123", "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 123, - "sku": "abc123" + "linked_product_type": "abc123", + "position": 987, + "sku": "xyz789" } ``` @@ -3625,17 +3617,17 @@ Contains an image in base64 format and basic information about the image. | Field Name | Description | |------------|-------------| -| `base64_encoded_data` - [`String`](types-q-s.md#string) | The image in base64 format. | -| `name` - [`String`](types-q-s.md#string) | The file name of the image. | -| `type` - [`String`](types-q-s.md#string) | The MIME type of the file, such as image/png. | +| `base64_encoded_data` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The image in base64 format. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of the image. | +| `type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "base64_encoded_data": "abc123", + "base64_encoded_data": "xyz789", "name": "xyz789", - "type": "xyz789" + "type": "abc123" } ``` @@ -3649,23 +3641,23 @@ Contains a link to a video file and basic information about the video. | Field Name | Description | |------------|-------------| -| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | -| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | -| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | -| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | -| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | -| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | +| `media_type` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL to the video. | #### Example ```json { - "media_type": "abc123", + "media_type": "xyz789", "video_description": "abc123", - "video_metadata": "xyz789", - "video_provider": "xyz789", + "video_metadata": "abc123", + "video_provider": "abc123", "video_title": "xyz789", - "video_url": "abc123" + "video_url": "xyz789" } ``` @@ -3681,7 +3673,7 @@ Represents a product price. |------------|-------------| | `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]`](types-f-i.md#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/latest/types-f-i.md#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 @@ -3729,25 +3721,25 @@ Contains details of a product review. | Field Name | Description | |------------|-------------| -| `average_rating` - [`Float!`](types-f-i.md#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](types-q-s.md#string) | The date the review was created. | -| `nickname` - [`String!`](types-q-s.md#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `average_rating` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the review was created. | +| `nickname` - [`String!`](/reference/graphql/latest/types-q-s.md#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!`](types-q-s.md#string) | The summary (title) of the review. | -| `text` - [`String!`](types-q-s.md#string) | The review text. | +| `summary` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The summary (title) of the review. | +| `text` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The review text. | #### Example ```json { - "average_rating": 123.45, + "average_rating": 987.65, "created_at": "abc123", "nickname": "xyz789", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], "summary": "xyz789", - "text": "abc123" + "text": "xyz789" } ``` @@ -3761,14 +3753,14 @@ Contains data about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example ```json { - "name": "xyz789", + "name": "abc123", "value": "abc123" } ``` @@ -3783,8 +3775,8 @@ Contains the reviewer's rating for a single aspect of a review. | Input Field | Description | |-------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | An encoded rating ID. | +| `value_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | An encoded rating value ID. | #### Example @@ -3805,8 +3797,8 @@ Contains details about a single aspect of a product review. | Field Name | Description | |------------|-------------| -| `id` - [`String!`](types-q-s.md#string) | An encoded rating ID. | -| `name` - [`String!`](types-q-s.md#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | An encoded rating ID. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#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 @@ -3814,7 +3806,7 @@ Contains details about a single aspect of a product review. ```json { "id": "xyz789", - "name": "abc123", + "name": "xyz789", "values": [ProductReviewRatingValueMetadata] } ``` @@ -3829,14 +3821,14 @@ Contains details about a single value in a product review. | Field Name | Description | |------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](types-q-s.md#string) | An encoded rating value ID. | +| `value` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | An encoded rating value ID. | #### Example ```json { - "value": "xyz789", + "value": "abc123", "value_id": "abc123" } ``` @@ -3870,7 +3862,7 @@ Contains an array of product reviews. | Field Name | Description | |------------|-------------| | `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | #### Example @@ -3910,21 +3902,21 @@ Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity d | Field Name | Description | |------------|-------------| -| `customer_group_id` - [`String`](types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | +| `customer_group_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json { - "customer_group_id": "abc123", + "customer_group_id": "xyz789", "percentage_value": 123.45, "qty": 123.45, "value": 123.45, - "website_id": 123.45 + "website_id": 987.65 } ``` @@ -3938,11 +3930,11 @@ Contains information about a product video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example @@ -3951,7 +3943,7 @@ Contains information about a product video. { "disabled": true, "label": "xyz789", - "position": 987, + "position": 123, "types": ["xyz789"], "url": "abc123", "video_content": ProductMediaGalleryEntriesVideoContent @@ -3968,13 +3960,13 @@ Contains the results of a `products` query. | Field Name | Description | |------------|-------------| -| `aggregations` - [`[Aggregation]`](types-a-b.md#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `aggregations` - [`[Aggregation]`](/reference/graphql/latest/types-a-b.md#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`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](types-f-i.md#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. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](/reference/graphql/latest/types-q-s.md#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](/reference/graphql/latest/types-q-s.md#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#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 @@ -3986,7 +3978,7 @@ Contains the results of a `products` query. "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } ``` @@ -4003,15 +3995,15 @@ Contains details about a purchase order. | `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!`](types-q-s.md#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](types-c-e.md#customer) | The company user who created the purchase order. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](/reference/graphql/latest/types-c-e.md#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!`](types-q-s.md#string) | The purchase order number. | -| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](types-c-e.md#cart) | The quote related to the purchase order. | +| `number` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](/reference/graphql/latest/types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](/reference/graphql/latest/types-c-e.md#cart) | The quote related to the purchase order. | | `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -4020,7 +4012,7 @@ Contains details about a purchase order. "approval_flow": [PurchaseOrderRuleApprovalFlow], "available_actions": ["REJECT"], "comments": [PurchaseOrderComment], - "created_at": "abc123", + "created_at": "xyz789", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], "number": "abc123", @@ -4062,13 +4054,13 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -4081,18 +4073,18 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | A formatted message. | -| `name` - [`String`](types-q-s.md#string) | The approver name. | -| `role` - [`String`](types-q-s.md#string) | The approver role. | +| `message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A formatted message. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The approver name. | +| `role` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The approver role. | | `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { "message": "abc123", - "name": "abc123", + "name": "xyz789", "role": "abc123", "status": "PENDING", "updated_at": "xyz789" @@ -4127,16 +4119,16 @@ Contains details about a purchase order approval rule. | Field Name | Description | |------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `applies_to_roles` - [`[CompanyRole]!`](/reference/graphql/latest/types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](/reference/graphql/latest/types-c-e.md#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!`](types-q-s.md#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The name of the purchase order approval rule. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the purchase order approval rule. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -4145,10 +4137,10 @@ Contains details about a purchase order approval rule. "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "xyz789", + "created_at": "xyz789", + "created_by": "abc123", "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", "uid": "4", "updated_at": "xyz789" @@ -4236,7 +4228,7 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | +| `quantity` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example @@ -4254,11 +4246,11 @@ Defines a new purchase order approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | +| `applies_to` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#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]!`](/reference/graphql/latest/types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](/reference/graphql/latest/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example @@ -4266,9 +4258,9 @@ Defines a new purchase order approval rule. ```json { "applies_to": ["4"], - "approvers": [4], + "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", + "description": "abc123", "name": "xyz789", "status": "ENABLED" } @@ -4284,9 +4276,9 @@ Contains metadata that can be used to render rule edit forms. | Field Name | Description | |------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | +| `available_applies_to` - [`[CompanyRole]!`](/reference/graphql/latest/types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](/reference/graphql/latest/types-a-b.md#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]!`](/reference/graphql/latest/types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4344,8 +4336,8 @@ Contains the approval rules that the customer can see. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4367,10 +4359,10 @@ Contains details about a comment. | Field Name | Description | |------------|-------------| -| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | -| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | +| `author` - [`Customer`](/reference/graphql/latest/types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | A unique identifier of the comment. | #### Example @@ -4413,17 +4405,17 @@ Contains details about a status change. | Field Name | Description | |------------|-------------| -| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | -| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | +| `activity` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { "activity": "abc123", - "created_at": "xyz789", + "created_at": "abc123", "message": "xyz789", "uid": 4 } @@ -4440,14 +4432,14 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | +| `rule_name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The name of the applied rule. | #### Example ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "xyz789" + "rule_name": "abc123" } ``` @@ -4486,8 +4478,8 @@ Contains a list of purchase orders. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4509,7 +4501,7 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of purchase order UIDs. | #### Example @@ -4549,9 +4541,9 @@ Defines the criteria to use to filter the list of purchase orders. | Input Field | Description | |-------------|-------------| -| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `company_purchase_orders` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](/reference/graphql/latest/types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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 @@ -4560,7 +4552,7 @@ Defines the criteria to use to filter the list of purchase orders. { "company_purchase_orders": false, "created_date": FilterRangeTypeInput, - "require_my_approval": false, + "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 index dac973f60..485fc133c 100644 --- 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 @@ -27,15 +27,15 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `item_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | | `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `templateId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "item_id": 4, + "item_id": "4", "note": "abc123", "templateId": "4" } @@ -59,7 +59,7 @@ Contains a notification message for a negotiable quote template. ```json { "message": "abc123", - "type": "abc123" + "type": "xyz789" } ``` @@ -72,7 +72,7 @@ Contains a notification message for a negotiable quote template. | Field Name | Description | |------------|-------------| | `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | +| `is_enabled` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | #### Example @@ -95,7 +95,7 @@ Contains reCAPTCHA form configuration details. |------------|-------------| | `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`](types-f-i.md#float) | The minimum score that identifies a user interaction as a potential risk. | +| `minimum_score` - [`Float`](/reference/graphql/latest/types-f-i.md#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. | @@ -108,11 +108,11 @@ Contains reCAPTCHA form configuration details. { "badge_position": "xyz789", "language_code": "abc123", - "minimum_score": 123.45, + "minimum_score": 987.65, "re_captcha_type": "INVISIBLE", - "technical_failure_message": "xyz789", - "theme": "abc123", - "validation_failure_message": "xyz789", + "technical_failure_message": "abc123", + "theme": "xyz789", + "validation_failure_message": "abc123", "website_key": "xyz789" } ``` @@ -130,9 +130,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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!`](types-a-b.md#boolean) | Return whether recaptcha is enabled or not | +| `is_enabled` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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!`](types-f-i.md#float) | The minimum score that identifies a user interaction as a potential risk. | +| `minimum_score` - [`Float!`](/reference/graphql/latest/types-f-i.md#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. | @@ -143,11 +143,11 @@ Contains reCAPTCHA V3-Invisible configuration details. "badge_position": "abc123", "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "abc123", - "minimum_score": 987.65, - "theme": "abc123", - "website_key": "abc123" + "is_enabled": true, + "language_code": "xyz789", + "minimum_score": 123.45, + "theme": "xyz789", + "website_key": "xyz789" } ``` @@ -204,7 +204,7 @@ Contains reCAPTCHA V3-Invisible configuration details. | Field Name | Description | |------------|-------------| | `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The unique ID for a `Region` object. | | `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example @@ -232,7 +232,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -245,7 +245,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](/reference/graphql/latest/types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -292,8 +292,8 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "abc123", - "gift_card_code": "xyz789" + "cart_id": "xyz789", + "gift_card_code": "abc123" } ``` @@ -307,7 +307,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -325,7 +325,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -343,12 +343,12 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example ```json -{"success": true} +{"success": false} ``` @@ -361,7 +361,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -380,8 +380,8 @@ Specifies which items to remove from the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `cart_item_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example @@ -389,7 +389,7 @@ Specifies which items to remove from the cart. { "cart_id": "abc123", "cart_item_id": 123, - "cart_item_uid": 4 + "cart_item_uid": "4" } ``` @@ -403,7 +403,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -421,13 +421,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_item_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_item_uids": [4], "quote_uid": "4"} +{"quote_item_uids": ["4"], "quote_uid": 4} ``` @@ -440,7 +440,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -458,13 +458,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `item_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"item_uids": ["4"], "template_id": 4} +{"item_uids": [4], "template_id": "4"} ``` @@ -477,13 +477,13 @@ Defines which products to remove from a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": ["4"], "uid": 4} +{"products": [4], "uid": 4} ``` @@ -496,8 +496,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/latest/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/latest/types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -518,12 +518,12 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example ```json -{"return_shipping_tracking_uid": 4} +{"return_shipping_tracking_uid": "4"} ``` @@ -554,7 +554,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -577,7 +577,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -590,7 +590,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -610,14 +610,14 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example ```json { - "quote_comment": "abc123", - "quote_name": "xyz789", + "quote_comment": "xyz789", + "quote_name": "abc123", "quote_uid": "4" } ``` @@ -632,7 +632,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -650,8 +650,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](/reference/graphql/latest/types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -698,9 +698,9 @@ Defines properties of a negotiable quote request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](types-a-b.md#boolean) | Flag indicating if quote is draft or not. | +| `cart_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](/reference/graphql/latest/types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Flag indicating if quote is draft or not. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -710,7 +710,7 @@ Defines properties of a negotiable quote request. "cart_id": "4", "comment": NegotiableQuoteCommentInput, "is_draft": false, - "quote_name": "xyz789" + "quote_name": "abc123" } ``` @@ -724,7 +724,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -742,12 +742,12 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example ```json -{"cart_id": 4} +{"cart_id": "4"} ``` @@ -763,14 +763,14 @@ Contains information needed to start a return request. | `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!`](types-f-i.md#id) | The unique ID for a `Order` object. | +| `order_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { - "comment_text": "xyz789", - "contact_email": "xyz789", + "comment_text": "abc123", + "contact_email": "abc123", "items": [RequestReturnItemInput], "order_uid": 4 } @@ -786,9 +786,9 @@ Contains details about an item to be returned. | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](types-f-i.md#float) | The quantity of the item to be returned. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](/reference/graphql/latest/types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](/reference/graphql/latest/types-f-i.md#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 @@ -840,19 +840,19 @@ Defines the contents of a requisition list. |------------|-------------| | `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!`](types-f-i.md#int) | The number of items in the list. | +| `items_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#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!`](types-f-i.md#id) | The unique requisition list ID. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "items": RequistionListItems, - "items_count": 987, + "items_count": 123, "name": "abc123", "requisition_list_items": RequisitionListItems, "uid": 4, @@ -870,8 +870,8 @@ Defines requisition list filters. | Input Field | Description | |-------------|-------------| -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/latest/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](/reference/graphql/latest/types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -893,20 +893,20 @@ The interface for requisition list items. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for the requisition list item. | #### Possible Types | RequisitionListItemInterface Types | |----------------| | [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | +| [`VirtualRequisitionListItem`](/reference/graphql/latest/types-t-z.md#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](/reference/graphql/latest/types-c-e.md#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](/reference/graphql/latest/types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](/reference/graphql/latest/types-c-e.md#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](/reference/graphql/latest/types-f-i.md#giftcardrequisitionlistitem) | #### Example @@ -915,7 +915,7 @@ The interface for requisition list items. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -931,7 +931,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | +| `total_pages` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of pages returned. | #### Example @@ -953,9 +953,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/latest/types-c-e.md#enteredoptioninput) | Entered option IDs. | | `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -965,9 +965,9 @@ Defines the items to add. { "entered_options": [EnteredOptionInput], "parent_sku": "abc123", - "quantity": 987.65, - "selected_options": ["abc123"], - "sku": "abc123" + "quantity": 123.45, + "selected_options": ["xyz789"], + "sku": "xyz789" } ``` @@ -983,7 +983,7 @@ Defines customer requisition lists. |------------|-------------| | `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -1007,7 +1007,7 @@ Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed |------------|-------------| | `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | +| `total_pages` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The number of pages returned. | #### Example @@ -1035,10 +1035,10 @@ Contains details about a return. | `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`](types-c-e.md#customerorder) | The order associated with the return. | +| `order` - [`CustomerOrder`](/reference/graphql/latest/types-c-e.md#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!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -1046,14 +1046,14 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "xyz789", + "created_at": "abc123", "customer": ReturnCustomer, "items": [ReturnItem], - "number": "xyz789", + "number": "abc123", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": 4 + "uid": "4" } ``` @@ -1070,16 +1070,16 @@ Contains details about a return comment. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example ```json { - "author_name": "xyz789", + "author_name": "abc123", "created_at": "abc123", - "text": "abc123", - "uid": 4 + "text": "xyz789", + "uid": "4" } ``` @@ -1094,7 +1094,7 @@ Contains details about a `ReturnCustomerAttribute` object. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ReturnCustomAttribute` object. | | `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | #### Example @@ -1102,8 +1102,8 @@ Contains details about a `ReturnCustomerAttribute` object. ```json { "label": "abc123", - "uid": 4, - "value": "xyz789" + "uid": "4", + "value": "abc123" } ``` @@ -1127,7 +1127,7 @@ The customer information for the return. { "email": "abc123", "firstname": "xyz789", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -1142,12 +1142,12 @@ Contains details about a product being returned. | 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]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item requested to be returned. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of the item requested to be returned. | | `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1157,7 +1157,7 @@ Contains details about a product being returned. "custom_attributesV2": [AttributeValueInterface], "order_item": OrderItemInterface, "quantity": 123.45, - "request_quantity": 987.65, + "request_quantity": 123.45, "status": "PENDING", "uid": "4" } @@ -1173,19 +1173,19 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](/reference/graphql/latest/types-f-i.md#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!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/latest/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | | `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/latest/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/latest/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether the attribute value must be unique. | | `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `multiline_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/latest/types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/latest/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example @@ -1202,7 +1202,7 @@ Return Item attribute metadata. "label": "abc123", "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -1262,7 +1262,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `city` - [`String!`](#string) | The city for product returns. | | `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](types-c-e.md#country) | An object that defines the country for product returns. | +| `country` - [`Country!`](/reference/graphql/latest/types-c-e.md#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. | @@ -1273,9 +1273,9 @@ Contains details about the shipping address used for receiving returned items. ```json { "city": "xyz789", - "contact_name": "abc123", + "contact_name": "xyz789", "country": Country, - "postcode": "xyz789", + "postcode": "abc123", "region": Region, "street": ["xyz789"], "telephone": "abc123" @@ -1293,7 +1293,7 @@ Contains details about the carrier on a return. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example @@ -1317,7 +1317,7 @@ Contains shipping and tracking details. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1406,7 +1406,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | +| `total_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The total number of return requests. | #### Example @@ -1414,7 +1414,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1428,12 +1428,12 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example ```json -{"result": true} +{"result": false} ``` @@ -1470,8 +1470,8 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | -| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | +| `money` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The reward points amount in points. | #### Example @@ -1492,14 +1492,14 @@ Contain details about the reward points transaction. | `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!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | +| `points_change` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example ```json { "balance": RewardPointsAmount, - "change_reason": "xyz789", + "change_reason": "abc123", "date": "abc123", "points_change": 987.65 } @@ -1537,13 +1537,13 @@ Contains details about customer's reward points rate. | Field Name | Description | |------------|-------------| -| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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. | +| `currency_amount` - [`Float!`](/reference/graphql/latest/types-f-i.md#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!`](/reference/graphql/latest/types-f-i.md#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} +{"currency_amount": 123.45, "points": 123.45} ``` @@ -1595,24 +1595,24 @@ Routable entities serve as the model for a rendered page. | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Possible Types | RoutableInterface Types | |----------------| -| [`CmsPage`](types-c-e.md#cmspage) | -| [`CategoryTree`](types-c-e.md#categorytree) | -| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`CmsPage`](/reference/graphql/latest/types-c-e.md#cmspage) | +| [`CategoryTree`](/reference/graphql/latest/types-c-e.md#categorytree) | +| [`VirtualProduct`](/reference/graphql/latest/types-t-z.md#virtualproduct) | | [`SimpleProduct`](#simpleproduct) | | [`RoutableUrl`](#routableurl) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | +| [`ConfigurableProduct`](/reference/graphql/latest/types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](/reference/graphql/latest/types-c-e.md#downloadableproduct) | +| [`BundleProduct`](/reference/graphql/latest/types-a-b.md#bundleproduct) | +| [`GiftCardProduct`](/reference/graphql/latest/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/latest/types-f-i.md#groupedproduct) | #### Example @@ -1634,15 +1634,15 @@ Default implementation of RoutableInterface. This type is returned when the URL | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](types-f-i.md#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. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "redirect_code": 123, + "redirect_code": 987, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -1688,7 +1688,7 @@ Contains details about a comment. ```json { "message": "abc123", - "timestamp": "abc123" + "timestamp": "xyz789" } ``` @@ -1722,14 +1722,14 @@ Provides navigation for the query response. | Field Name | Description | |------------|-------------| -| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | -| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | +| `current_page` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 123, "page_size": 987, "total_pages": 987} +{"current_page": 987, "page_size": 123, "total_pages": 123} ``` @@ -1760,10 +1760,10 @@ Contains details about a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `uid` instead)* | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example @@ -1771,8 +1771,8 @@ Contains details about a selected bundle option. ```json { "id": 123, - "label": "abc123", - "type": "xyz789", + "label": "xyz789", + "type": "abc123", "uid": "4", "values": [SelectedBundleOptionValue] } @@ -1788,24 +1788,24 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | Use `uid` instead | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Use `uid` instead | | `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `original_price` - [`Money!`](types-k-p.md#money) | The original price of the value for the selected bundle product option. | -| `price` - [`Float!`](types-f-i.md#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | -| `priceV2` - [`Money!`](types-k-p.md#money) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `original_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The original price of the value for the selected bundle product option. | +| `price` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | +| `priceV2` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { - "id": 987, - "label": "xyz789", + "id": 123, + "label": "abc123", "original_price": Money, "price": 123.45, "priceV2": Money, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" } ``` @@ -1820,22 +1820,22 @@ Contains details about a selected configurable option. | Field Name | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `configurable_product_option_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | | `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_id` - [`Int!`](/reference/graphql/latest/types-f-i.md#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_uid": "4", "configurable_product_option_value_uid": 4, "id": 123, - "option_label": "xyz789", - "value_id": 987, + "option_label": "abc123", + "value_id": 123, "value_label": "abc123" } ``` @@ -1857,7 +1857,7 @@ Contains details about an attribute the buyer selected. ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "xyz789" } ``` @@ -1872,11 +1872,11 @@ Identifies a customized product that has been placed in a cart. | Field Name | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customizable option is required. | +| `customizable_option_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the customizable option is required. | | `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](types-f-i.md#int) | A value indicating the order to display this option. | +| `sort_order` - [`Int!`](/reference/graphql/latest/types-f-i.md#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. | @@ -1884,12 +1884,12 @@ Identifies a customized product that has been placed in a cart. ```json { - "customizable_option_uid": 4, + "customizable_option_uid": "4", "id": 123, "is_required": false, - "label": "abc123", - "sort_order": 987, - "type": "xyz789", + "label": "xyz789", + "sort_order": 123, + "type": "abc123", "values": [SelectedCustomizableOptionValue] } ``` @@ -1904,21 +1904,21 @@ Identifies the value of the selected customized option. | Field Name | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `customizable_option_value_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | | `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](/reference/graphql/latest/types-c-e.md#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", + "customizable_option_value_uid": 4, + "id": 123, + "label": "xyz789", "price": CartItemSelectedOptionValuePrice, - "value": "abc123" + "value": "xyz789" } ``` @@ -1941,7 +1941,7 @@ Describes the payment method the shopper selected. ```json { "code": "xyz789", - "purchase_order_number": "xyz789", + "purchase_order_number": "abc123", "title": "abc123" } ``` @@ -1956,14 +1956,14 @@ Contains details about the selected shipping method and carrier. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](types-k-p.md#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](/reference/graphql/latest/types-k-p.md#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!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `price_excl_tax` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1971,10 +1971,10 @@ Contains details about the selected shipping method and carrier. { "amount": Money, "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "xyz789", + "carrier_code": "xyz789", + "carrier_title": "abc123", "method_code": "xyz789", - "method_title": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1990,7 +1990,7 @@ Defines the referenced product and the email sender and recipients. | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](types-f-i.md#int) | The ID of the product that the sender is referencing. | +| `product_id` - [`Int!`](/reference/graphql/latest/types-f-i.md#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. | @@ -2066,7 +2066,7 @@ Contains details about a recipient. ```json { "email": "abc123", - "name": "xyz789" + "name": "abc123" } ``` @@ -2089,8 +2089,8 @@ An output object that contains information about the sender. ```json { "email": "xyz789", - "message": "xyz789", - "name": "xyz789" + "message": "abc123", + "name": "abc123" } ``` @@ -2113,8 +2113,8 @@ Contains details about the sender. ```json { "email": "xyz789", - "message": "abc123", - "name": "xyz789" + "message": "xyz789", + "name": "abc123" } ``` @@ -2128,13 +2128,13 @@ Contains details about the configuration of the Email to a Friend feature. | Field Name | Description | |------------|-------------| -| `enabled_for_customers` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | +| `enabled_for_customers` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"enabled_for_customers": true, "enabled_for_guests": true} +{"enabled_for_customers": false, "enabled_for_guests": true} ``` @@ -2147,16 +2147,13 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](/reference/graphql/latest/types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "comment": NegotiableQuoteCommentInput, - "quote_uid": "4" -} +{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} ``` @@ -2169,7 +2166,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2187,7 +2184,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](/reference/graphql/latest/types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2209,7 +2206,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2228,12 +2225,12 @@ Sets the cart as inactive | Field Name | Description | |------------|-------------| | `error` - [`String`](#string) | The error message returned after failing to set the cart as inactive | -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart was set as inactive | +| `success` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the cart was set as inactive | #### Example ```json -{"error": "abc123", "success": false} +{"error": "xyz789", "success": true} ``` @@ -2247,10 +2244,10 @@ Defines the gift options applied to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/latest/types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example @@ -2258,9 +2255,9 @@ Defines the gift options applied to the cart. { "cart_id": "xyz789", "gift_message": GiftMessageInput, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping_id": "4", - "printed_card_included": false + "printed_card_included": true } ``` @@ -2274,7 +2271,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The modified cart object. | #### Example @@ -2299,7 +2296,7 @@ Defines the guest email and cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "email": "abc123" } ``` @@ -2314,7 +2311,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2332,7 +2329,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2350,8 +2347,8 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](/reference/graphql/latest/types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2372,7 +2369,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2390,8 +2387,8 @@ Defines the payment method of the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](/reference/graphql/latest/types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2412,7 +2409,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2430,16 +2427,16 @@ Defines the shipping address to assign to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `customer_address_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| `customer_address_id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](/reference/graphql/latest/types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { "customer_address_id": "4", - "quote_uid": "4", + "quote_uid": 4, "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2456,7 +2453,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2474,14 +2471,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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, + "quote_uid": "4", "shipping_methods": [ShippingMethodInput] } ``` @@ -2496,7 +2493,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2514,15 +2511,15 @@ Defines the shipping address to assign to the negotiable quote template. | Input Field | Description | |-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": "4" + "template_id": 4 } ``` @@ -2537,13 +2534,13 @@ Applies a payment method to the quote. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/latest/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "payment_method": PaymentMethodInput } ``` @@ -2559,7 +2556,7 @@ Applies a payment method to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/latest/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example @@ -2580,7 +2577,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2605,7 +2602,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2620,7 +2617,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2660,7 +2657,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2685,7 +2682,7 @@ Defines a gift registry invitee. ```json { - "email": "abc123", + "email": "xyz789", "name": "abc123" } ``` @@ -2700,12 +2697,12 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example ```json -{"is_shared": false} +{"is_shared": true} ``` @@ -2725,7 +2722,7 @@ Defines the sender of an invitation to view a gift registry. ```json { - "message": "xyz789", + "message": "abc123", "name": "xyz789" } ``` @@ -2757,12 +2754,12 @@ Defines whether bundle items must be shipped together. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | #### Example @@ -2770,10 +2767,10 @@ Defines whether bundle items must be shipped together. { "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -2787,30 +2784,30 @@ Order shipment item details. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/latest/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | -| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | +| [`BundleShipmentItem`](/reference/graphql/latest/types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](/reference/graphql/latest/types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example ```json { - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_shipped": 987.65 } ``` @@ -2833,7 +2830,7 @@ Contains order shipment tracking details. ```json { - "carrier": "xyz789", + "carrier": "abc123", "number": "xyz789", "title": "abc123" } @@ -2849,9 +2846,9 @@ Defines a single shipping address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `address` - [`CartAddressInput`](/reference/graphql/latest/types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#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. | @@ -2860,10 +2857,10 @@ Defines a single shipping address. ```json { "address": CartAddressInput, - "customer_address_id": 123, - "customer_address_uid": 4, - "customer_notes": "abc123", - "pickup_location_code": "xyz789" + "customer_address_id": 987, + "customer_address_uid": "4", + "customer_notes": "xyz789", + "pickup_location_code": "abc123" } ``` @@ -2877,31 +2874,31 @@ Contains shipping addresses and methods. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | An array that lists the items in the cart. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/latest/types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](/reference/graphql/latest/types-c-e.md#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](/reference/graphql/latest/types-c-e.md#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!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/latest/types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `items_weight` - [`Float`](types-f-i.md#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `items_weight` - [`Float`](/reference/graphql/latest/types-f-i.md#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`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `same_as_billing` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shipping address is same as billing address. | +| `region` - [`CartAddressRegion`](/reference/graphql/latest/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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!`](types-f-i.md#id) | The unique id of the customer cart address. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique id of the customer cart address. | | `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example @@ -2911,28 +2908,28 @@ Contains shipping addresses and methods. "available_shipping_methods": [AvailableShippingMethod], "cart_items": [CartItemQuantity], "cart_items_v2": [CartItemInterface], - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", + "customer_address_uid": 4, "customer_notes": "xyz789", - "fax": "xyz789", - "firstname": "xyz789", - "id": 987, + "fax": "abc123", + "firstname": "abc123", + "id": 123, "items_weight": 987.65, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "abc123", "pickup_location_code": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": CartAddressRegion, "same_as_billing": false, "selected_shipping_method": SelectedShippingMethod, "street": ["xyz789"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", - "uid": 4, + "uid": "4", "vat_id": "xyz789" } ``` @@ -2947,7 +2944,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The amount of the discount. | #### Example @@ -2965,11 +2962,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](types-k-p.md#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The shipping amount, including tax. | | `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | +| `taxes` - [`[TaxItem]`](/reference/graphql/latest/types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The total amount for shipping. | #### Example @@ -3000,7 +2997,7 @@ Defines the shipping carrier and method. ```json { - "carrier_code": "xyz789", + "carrier_code": "abc123", "method_code": "xyz789" } ``` @@ -3015,23 +3012,23 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/latest/types-f-i.md#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]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `discount` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/latest/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/latest/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/latest/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | | `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `is_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#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]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/latest/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -3043,11 +3040,11 @@ An implementation for simple product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": false, + "id": "xyz789", + "is_available": true, "max_qty": 987.65, "min_qty": 987.65, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -3067,69 +3064,69 @@ Defines a simple product, which is tangible and is usually sold in single units | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `attribute_set_id` - [`Int`](/reference/graphql/latest/types-f-i.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `categories` - [`[CategoryInterface]`](/reference/graphql/latest/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/latest/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/latest/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#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`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `manufacturer` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/latest/types-k-p.md#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`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `min_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/latest/types-c-e.md#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`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | +| `price` - [`ProductPrices`](/reference/graphql/latest/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/latest/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/latest/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#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!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `review_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#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`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `small_image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#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`](types-f-i.md#float) | The discounted price of the product. | +| `special_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The discounted price of the product. | | `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/latest/types-k-p.md#productstockstatus) | Stock status of the product | | `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](types-t-z.md#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `thumbnail` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](/reference/graphql/latest/types-t-z.md#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!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#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]`](types-k-p.md#productinterface) | An array of up-sell products. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#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]`](types-t-z.md#urlrewrite) | URL rewrites list | +| `url_rewrites` - [`[UrlRewrite]`](/reference/graphql/latest/types-t-z.md#urlrewrite) | URL rewrites list | | `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `websites` - [`[Website]`](/reference/graphql/latest/types-t-z.md#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example @@ -3139,49 +3136,49 @@ Defines a simple product, which is tangible and is usually sold in single units "canonical_url": "abc123", "categories": [CategoryInterface], "color": 987, - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "id": 123, "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 123, + "is_returnable": "xyz789", + "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, - "rating_summary": 123.45, + "rating_summary": 987.65, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "abc123", + "relative_url": "xyz789", "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_from_date": "xyz789", - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", - "staged": false, + "staged": true, "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, @@ -3197,7 +3194,7 @@ Defines a simple product, which is tangible and is usually sold in single units "url_rewrites": [UrlRewrite], "url_suffix": "xyz789", "websites": [Website], - "weight": 987.65 + "weight": 123.45 } ``` @@ -3211,8 +3208,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/latest/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/latest/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -3234,9 +3231,9 @@ Contains details about simple products added to a requisition list. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3244,7 +3241,7 @@ Contains details about simple products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" } ``` @@ -3262,20 +3259,20 @@ Contains a simple 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!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -3297,9 +3294,9 @@ Smart button payment inputs ```json { - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "abc123", - "paypal_order_id": "abc123" + "paypal_order_id": "xyz789" } ``` @@ -3311,13 +3308,13 @@ Smart button payment inputs | Field Name | Description | |------------|-------------| -| `app_switch_when_available` - [`Boolean`](types-a-b.md#boolean) | Indicated whether to use App Switch on enabled mobile devices | -| `button_styles` - [`ButtonStyles`](types-a-b.md#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `app_switch_when_available` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicated whether to use App Switch on enabled mobile devices | +| `button_styles` - [`ButtonStyles`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](types-k-p.md#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `display_message` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](/reference/graphql/latest/types-k-p.md#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 | @@ -3332,12 +3329,12 @@ Smart button payment inputs "code": "xyz789", "display_message": true, "display_venmo": true, - "is_visible": true, + "is_visible": false, "message_styles": MessageStyles, "payment_intent": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "xyz789" + "sort_order": "xyz789", + "title": "abc123" } ``` @@ -3378,7 +3375,7 @@ Defines a possible sort field. ```json { "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -3399,7 +3396,7 @@ Contains a default value for sort fields and all available sort fields. ```json { - "default": "xyz789", + "default": "abc123", "options": [SortField] } ``` @@ -3472,27 +3469,27 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `autocomplete_on_storefront` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | -| `braintree_3dsecure_always_request_3ds` - [`Boolean`](types-a-b.md#boolean) | Braintree 3D Secure, always request 3D Secure flag. | +| `braintree_3dsecure_allowspecific` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | -| `braintree_ach_direct_debit_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree ACH vault status. | +| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Braintree ACH vault status. | | `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | -| `braintree_applepay_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree Apple Pay vault status. | +| `braintree_applepay_vault_active` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Braintree Apple Pay vault status. | | `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | -| `braintree_cc_vault_cvv` - [`Boolean`](types-a-b.md#boolean) | Braintree cc vault CVV re-verification enabled status. | +| `braintree_cc_vault_cvv` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree Google Pay vault status. | +| `braintree_googlepay_vault_active` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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. | @@ -3500,130 +3497,130 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | +| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal mini-cart & cart button show. | +| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Credit checkout button show status. | +| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging checkout show status. | +| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later checkout button show status. | +| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal checkout button show. | +| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Credit PDP button show status. | +| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later messaging PDP show status. | +| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal Pay Later PDP button show status. | +| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Braintree PayPal PDP button show. | +| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Should display Braintree PayPal in mini-cart & cart? | +| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | -| `braintree_paypal_send_cart_line_items` - [`Boolean`](types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | -| `braintree_paypal_vault_active` - [`Boolean`](types-a-b.md#boolean) | Braintree PayPal vault status. | -| `cart_expires_in_days` - [`Int`](types-f-i.md#int) | checkout/cart/delete_quote_after: quote lifetime in days. | +| `braintree_paypal_require_billing_address` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#int) | checkout/cart_link/use_qty: what to show in the display cart summary, number of items or item quantities. | +| `cart_summary_display_quantity` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/latest/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#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_sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#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!`](types-k-p.md#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | +| `configurable_product_image` - [`ProductImageThumbnail!`](/reference/graphql/latest/types-k-p.md#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!`](types-a-b.md#boolean) | Indicates whether the Contact Us form in enabled. | +| `contact_enabled` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](types-f-i.md#float) | Customer access token lifetime. | +| `create_account_confirmation` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#int) | Configuration data from tax/display/type | -| `display_shipping_prices` - [`Int!`](types-f-i.md#int) | Configuration data from tax/display/shipping | -| `display_state_if_optional` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - general/region/display_all | +| `demonotice` - [`Int`](/reference/graphql/latest/types-f-i.md#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!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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!`](types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | -| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_email | -| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_list | -| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_sales | -| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display | -| `fixed_product_taxes_enable` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/enable | -| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/include_in_subtotal | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | -| `grid_per_page` - [`Int`](types-f-i.md#int) | The default number of products per page in Grid View. | +| `graphql_share_customer_group` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](/reference/graphql/latest/types-f-i.md#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!`](types-k-p.md#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | +| `grouped_product_image` - [`ProductImageThumbnail!`](/reference/graphql/latest/types-k-p.md#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`](types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_checkout_agreements_enabled` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | -| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | -| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_checkout_agreements_enabled` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#int) | The default number of products per page in List View. | +| `list_per_page` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](types-f-i.md#int) | The width of the logo image, in pixels. | +| `logo_height` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](/reference/graphql/latest/types-f-i.md#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. | @@ -3638,34 +3635,34 @@ Contains information about a store's configuration. | `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`](types-f-i.md#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | +| `max_items_in_order_summary` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | -| `minicart_max_items` - [`Int`](types-f-i.md#int) | checkout/sidebar/count: maximum number of items to show in minicart. | +| `minicart_display` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](/reference/graphql/latest/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether newsletters are enabled. | +| `newsletter_enabled` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | -| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | -| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | -| `orders_invoices_credit_memos_display_price` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/price | -| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/shipping | -| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | -| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/zero_tax | +| `order_cancellation_enabled` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](/reference/graphql/latest/types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-k-p.md#money) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages. | +| `printed_card_priceV2` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/latest/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether quick order functionality is enabled. | +| `quickorder_active` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `root_category_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/latest/types-f-i.md#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`. | @@ -3673,37 +3670,37 @@ Contains information about a store's configuration. | `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`](types-a-b.md#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | -| `share_applied_cart_rule` - [`Boolean`](types-a-b.md#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | -| `shopping_cart_display_full_summary` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `show_cms_breadcrumbs` - [`Int`](types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `share_active_segments` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | +| `share_applied_cart_rule` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | +| `shopping_cart_display_full_summary` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](/reference/graphql/latest/types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-f-i.md#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`](types-f-i.md#int) | The store view sort order. | +| `store_sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | -| `website_id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `use_store_in_url` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for the website. | +| `website_id` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_enable_for_specific_countries` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#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`](types-f-i.md#int) | A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout. | +| `zero_subtotal_sort_order` - [`Int`](/reference/graphql/latest/types-f-i.md#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 @@ -3715,171 +3712,171 @@ Contains information about a store's configuration. "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "abc123", + "allow_items": "xyz789", "allow_order": "xyz789", "allow_printed_card": "xyz789", "autocomplete_on_storefront": false, "base_currency_code": "abc123", - "base_link_url": "abc123", + "base_link_url": "xyz789", "base_media_url": "abc123", - "base_static_url": "abc123", + "base_static_url": "xyz789", "base_url": "xyz789", - "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": true, + "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_always_request_3ds": false, "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": true, - "braintree_applepay_merchant_name": "abc123", + "braintree_applepay_merchant_name": "xyz789", "braintree_applepay_vault_active": true, - "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_active": "abc123", "braintree_cc_vault_cvv": false, "braintree_environment": "abc123", "braintree_googlepay_btn_color": "abc123", - "braintree_googlepay_cctypes": "xyz789", - "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": false, - "braintree_local_payment_allowed_methods": "abc123", + "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_merchant_id": "xyz789", + "braintree_googlepay_vault_active": true, + "braintree_local_payment_allowed_methods": "xyz789", "braintree_local_payment_fallback_button_text": "abc123", "braintree_local_payment_redirect_on_fail": "xyz789", "braintree_merchant_account_id": "xyz789", "braintree_paypal_button_location_cart_type_credit_color": "abc123", "braintree_paypal_button_location_cart_type_credit_label": "xyz789", "braintree_paypal_button_location_cart_type_credit_shape": "xyz789", - "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": "xyz789", - "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_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": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_label": "abc123", "braintree_paypal_button_location_cart_type_paylater_shape": "abc123", "braintree_paypal_button_location_cart_type_paylater_show": true, "braintree_paypal_button_location_cart_type_paypal_color": "abc123", "braintree_paypal_button_location_cart_type_paypal_label": "abc123", - "braintree_paypal_button_location_cart_type_paypal_shape": "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": "abc123", - "braintree_paypal_button_location_checkout_type_credit_show": false, + "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": "xyz789", "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_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": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_label": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", + "braintree_paypal_button_location_checkout_type_paypal_show": false, + "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", - "braintree_paypal_button_location_productpage_type_credit_shape": "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_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_text_color": "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": "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_shape": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_show": true, "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": 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": "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": false, "braintree_paypal_vault_active": true, - "cart_expires_in_days": 123, - "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "abc123", + "cart_expires_in_days": 987, + "cart_gift_wrapping": "abc123", + "cart_merge_preference": "xyz789", "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": "abc123", - "check_money_order_enable_for_specific_countries": true, + "category_url_suffix": "xyz789", + "check_money_order_enable_for_specific_countries": false, "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "xyz789", + "check_money_order_make_check_payable_to": "abc123", "check_money_order_max_order_total": "xyz789", - "check_money_order_min_order_total": "xyz789", - "check_money_order_new_order_status": "xyz789", - "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_min_order_total": "abc123", + "check_money_order_new_order_status": "abc123", + "check_money_order_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 987, + "check_money_order_sort_order": 123, "check_money_order_title": "abc123", - "cms_home_page": "xyz789", - "cms_no_cookies": "xyz789", + "cms_home_page": "abc123", + "cms_no_cookies": "abc123", "cms_no_route": "xyz789", - "code": "abc123", + "code": "xyz789", "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", "contact_enabled": false, "copyright": "xyz789", "countries_with_required_region": "xyz789", - "create_account_confirmation": true, - "customer_access_token_lifetime": 987.65, - "default_country": "xyz789", + "create_account_confirmation": false, + "customer_access_token_lifetime": 123.45, + "default_country": "abc123", "default_description": "abc123", - "default_display_currency_code": "xyz789", - "default_keywords": "abc123", - "default_title": "xyz789", - "demonotice": 987, + "default_display_currency_code": "abc123", + "default_keywords": "xyz789", + "default_title": "abc123", + "demonotice": 123, "display_product_prices_in_catalog": 987, - "display_shipping_prices": 987, + "display_shipping_prices": 123, "display_state_if_optional": true, "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_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": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": true, - "fixed_product_taxes_include_fpt_in_subtotal": true, - "front": "xyz789", + "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_enable": false, + "fixed_product_taxes_include_fpt_in_subtotal": false, + "front": "abc123", "graphql_share_customer_group": false, - "grid_per_page": 987, + "grid_per_page": 123, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "head_includes": "xyz789", + "head_includes": "abc123", "head_shortcut_icon": "abc123", "header_logo_src": "abc123", - "id": 987, - "is_checkout_agreements_enabled": true, - "is_default_store": true, - "is_default_store_group": true, - "is_guest_checkout_enabled": true, + "id": 123, + "is_checkout_agreements_enabled": false, + "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_mode": "abc123", "list_per_page": 123, "list_per_page_values": "abc123", - "locale": "xyz789", + "locale": "abc123", "logo_alt": "xyz789", "logo_height": 987, - "logo_width": 987, + "logo_width": 123, "magento_reward_general_is_enabled": "abc123", "magento_reward_general_is_enabled_on_front": "xyz789", "magento_reward_general_min_points_balance": "abc123", - "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "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": "abc123", - "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "abc123", - "magento_reward_points_order": "xyz789", + "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_order_limit": "xyz789", + "magento_reward_points_newsletter": "xyz789", + "magento_reward_points_order": "abc123", "magento_reward_points_register": "abc123", "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", @@ -3888,67 +3885,67 @@ Contains information about a store's configuration. "maximum_number_of_wishlists": "xyz789", "minicart_display": false, "minicart_max_items": 987, - "minimum_password_length": "xyz789", + "minimum_password_length": "abc123", "newsletter_enabled": true, "no_route": "xyz789", - "optional_zip_countries": "abc123", - "order_cancellation_enabled": false, + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": true, - "orders_invoices_credit_memos_display_grandtotal": false, + "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": 987, "orders_invoices_credit_memos_display_zero_tax": false, - "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": "abc123", + "product_reviews_enabled": "xyz789", "product_url_suffix": "xyz789", - "quickorder_active": false, + "quickorder_active": true, "required_character_classes_number": "abc123", "returns_enabled": "xyz789", - "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": "abc123", - "sales_printed_card": "xyz789", + "sales_printed_card": "abc123", "secure_base_link_url": "xyz789", - "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_media_url": "xyz789", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "share_active_segments": false, - "share_applied_cart_rule": true, + "share_applied_cart_rule": false, "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": false, + "shopping_cart_display_grand_total": true, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, - "show_cms_breadcrumbs": 987, + "show_cms_breadcrumbs": 123, "store_code": "4", - "store_group_code": 4, - "store_group_name": "xyz789", - "store_name": "abc123", - "store_sort_order": 987, + "store_group_code": "4", + "store_group_name": "abc123", + "store_name": "xyz789", + "store_sort_order": 123, "timezone": "abc123", - "title_prefix": "xyz789", - "title_separator": "abc123", + "title_prefix": "abc123", + "title_separator": "xyz789", "title_suffix": "abc123", "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": true, - "zero_subtotal_enabled": true, + "weight_unit": "abc123", + "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_payment_from_specific_countries": "abc123", + "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 123, "zero_subtotal_title": "xyz789" } @@ -3964,21 +3961,21 @@ Indicates where an attribute can be displayed. | Field Name | Description | |------------|-------------| -| `position` - [`Int`](types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | +| `position` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](/reference/graphql/latest/types-t-z.md#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example ```json { - "position": 987, + "position": 123, "use_in_layered_navigation": "NO", "use_in_product_listing": false, - "use_in_search_results_layered_navigation": true, - "visible_on_catalog_pages": true + "use_in_search_results_layered_navigation": false, + "visible_on_catalog_pages": false } ``` @@ -3993,7 +3990,7 @@ represent free-form human-readable text. #### Example ```json -"abc123" +"xyz789" ``` @@ -4007,20 +4004,20 @@ Specifies the quote template properties to update. | Input Field | Description | |-------------|-------------| | `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for minimum orders | +| `max_order_commitment` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Commitment for minimum orders | | `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "comment": "abc123", + "comment": "xyz789", "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "abc123", + "min_order_commitment": 123, + "name": "xyz789", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], @@ -4085,7 +4082,7 @@ Describes the swatch type and a value. ```json { "type": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -4103,9 +4100,9 @@ Describes the swatch type and a value. | SwatchDataInterface Types | |----------------| -| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | -| [`TextSwatchData`](types-t-z.md#textswatchdata) | -| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | +| [`ImageSwatchData`](/reference/graphql/latest/types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](/reference/graphql/latest/types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](/reference/graphql/latest/types-c-e.md#colorswatchdata) | #### Example @@ -4156,7 +4153,7 @@ Swatch attribute metadata input types. | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](types-f-i.md#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `items_count` - [`Int`](/reference/graphql/latest/types-f-i.md#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.)* | @@ -4212,7 +4209,7 @@ Synchronizes the payment order details ```json { "cartId": "xyz789", - "id": "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 index 7472e77f3..51fae2961 100644 --- 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 @@ -8,9 +8,9 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | -| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | +| `amount` - [`Money!`](/reference/graphql/latest/types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A title that describes the tax. | #### Example @@ -48,12 +48,12 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -86,9 +86,9 @@ Defines a price based on the quantity purchased. | Field Name | Description | |------------|-------------| -| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | -| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | +| `discount` - [`ProductDiscount`](/reference/graphql/latest/types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -110,14 +110,14 @@ Modifies the specified items in the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | +| `cart_id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](/reference/graphql/latest/types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [CartItemUpdateInput] } ``` @@ -132,8 +132,8 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/latest/types-c-e.md#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](/reference/graphql/latest/types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | #### Example @@ -154,7 +154,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/latest/types-c-e.md#company) | The updated company instance. | #### Example @@ -172,7 +172,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](/reference/graphql/latest/types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -190,7 +190,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/latest/types-c-e.md#company) | The updated company instance. | #### Example @@ -208,7 +208,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](/reference/graphql/latest/types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -226,7 +226,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | +| `user` - [`Customer!`](/reference/graphql/latest/types-c-e.md#customer) | The updated company user instance. | #### Example @@ -244,12 +244,12 @@ Defines updates to a `GiftRegistry` object. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | -| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/latest/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](/reference/graphql/latest/types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/latest/types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](/reference/graphql/latest/types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -259,7 +259,7 @@ Defines updates to a `GiftRegistry` object. GiftRegistryDynamicAttributeInput ], "event_name": "xyz789", - "message": "abc123", + "message": "xyz789", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, "status": "ACTIVE" @@ -276,15 +276,15 @@ Defines updates to an item in a gift registry. | Input Field | Description | |-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | +| `gift_registry_item_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { - "gift_registry_item_uid": 4, + "gift_registry_item_uid": "4", "note": "abc123", "quantity": 123.45 } @@ -300,7 +300,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -318,7 +318,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -336,11 +336,11 @@ Defines updates to an existing registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | -| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/latest/types-f-i.md#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`](/reference/graphql/latest/types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -349,10 +349,10 @@ Defines updates to an existing registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", + "email": "abc123", "firstname": "abc123", - "gift_registry_registrant_uid": "4", - "lastname": "abc123" + "gift_registry_registrant_uid": 4, + "lastname": "xyz789" } ``` @@ -366,7 +366,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/latest/types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -384,7 +384,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/latest/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -402,15 +402,15 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](/reference/graphql/latest/types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -424,7 +424,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -442,8 +442,8 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](/reference/graphql/latest/types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -486,22 +486,22 @@ Defines the changes to be made to an approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | -| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | +| `applies_to` - [`[ID]`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](/reference/graphql/latest/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { "applies_to": ["4"], - "approvers": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", "uid": 4 @@ -518,8 +518,8 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The new name of the requisition list. | #### Example @@ -540,17 +540,17 @@ Defines which items in a requisition list to update. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/latest/types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](/reference/graphql/latest/types-q-s.md#string) | An array of selected option IDs. | #### Example ```json { "entered_options": [EnteredOptionInput], - "item_id": "4", + "item_id": 4, "quantity": 123.45, "selected_options": ["abc123"] } @@ -566,7 +566,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -584,7 +584,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/latest/types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -602,15 +602,15 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The wish list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of a `Wishlist` object. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json { - "name": "xyz789", + "name": "abc123", "uid": "4", "visibility": "PUBLIC" } @@ -626,8 +626,8 @@ Contains URL rewrite details. | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](types-f-i.md#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](types-q-s.md#string) | The request URL. | +| `parameters` - [`[HttpQueryParameter]`](/reference/graphql/latest/types-f-i.md#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The request URL. | #### Example @@ -688,15 +688,15 @@ Defines the input for returning matching companies the customer is assigned to. | Input Field | Description | |-------------|-------------| -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | -| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | +| `currentPage` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](/reference/graphql/latest/types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example ```json { - "currentPage": 123, + "currentPage": 987, "pageSize": 123, "sort": [CompaniesSortInput] } @@ -712,8 +712,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](/reference/graphql/latest/types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -734,13 +734,13 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{"message": "xyz789", "type": "NOT_FOUND"} ``` @@ -773,7 +773,7 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/latest/types-f-i.md#id) | An array of the purchase order IDs. | #### Example @@ -792,7 +792,7 @@ Contains the results of validation attempts. | Field Name | Description | |------------|-------------| | `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | +| `purchase_orders` - [`[PurchaseOrder]!`](/reference/graphql/latest/types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -814,14 +814,14 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](types-q-s.md#string) | Validation rule value. | +| `value` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Validation rule value. | #### Example ```json { "name": "DATE_RANGE_MAX", - "value": "abc123" + "value": "xyz789" } ``` @@ -877,8 +877,8 @@ Retrieves the vault configuration | Field Name | Description | |------------|-------------| -| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | +| `is_vault_enabled` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/latest/types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | | `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | #### Example @@ -901,10 +901,10 @@ Vault payment inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | +| `payment_source` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The public hash of the token. | #### Example @@ -913,7 +913,7 @@ Vault payment inputs "payment_source": "xyz789", "payments_order_id": "abc123", "paypal_order_id": "xyz789", - "public_hash": "abc123" + "public_hash": "xyz789" } ``` @@ -927,7 +927,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](types-k-p.md#paymentsourceinput) | The payment source information | +| `payment_source` - [`PaymentSourceInput!`](/reference/graphql/latest/types-k-p.md#paymentsourceinput) | The payment source information | #### Example @@ -945,12 +945,12 @@ Contains required input for payment methods with Vault support. | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the payment token. | +| `public_hash` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The public hash of the payment token. | #### Example ```json -{"public_hash": "abc123"} +{"public_hash": "xyz789"} ``` @@ -963,20 +963,20 @@ An implementation for virtual product cart items. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/latest/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/latest/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/latest/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/latest/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -985,17 +985,17 @@ An implementation for virtual product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "abc123", + "id": "xyz789", "is_available": false, - "max_qty": 987.65, - "min_qty": 123.45, + "max_qty": 123.45, + "min_qty": 987.65, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 } ``` @@ -1009,86 +1009,86 @@ Defines a virtual product, which is a non-tangible product that does not require | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `created_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `attribute_set_id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](/reference/graphql/latest/types-q-s.md#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]`](/reference/graphql/latest/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product's country of origin. | +| `created_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/latest/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/latest/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/latest/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](/reference/graphql/latest/types-k-p.md#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/latest/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/latest/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](/reference/graphql/latest/types-k-p.md#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](/reference/graphql/latest/types-k-p.md#pricerange) | The range of prices for the product | | `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Amount of available stock | -| `rating_summary` - [`Float!`](types-f-i.md#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](types-f-i.md#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]`](types-k-p.md#productinterface) | An array of related products. | -| `relative_url` - [`String`](types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](types-f-i.md#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](types-k-p.md#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](types-f-i.md#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]`](types-k-p.md#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/latest/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | Amount of available stock | +| `rating_summary` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of related products. | +| `relative_url` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](/reference/graphql/latest/types-f-i.md#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](/reference/graphql/latest/types-k-p.md#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/latest/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/latest/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/latest/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](/reference/graphql/latest/types-f-i.md#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]`](/reference/graphql/latest/types-k-p.md#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`](types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `type_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/latest/types-k-p.md#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](/reference/graphql/latest/types-q-s.md#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | | `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](types-q-s.md#string) | The part of the product URL that is appended after the url key | +| `url_suffix` - [`String`](/reference/graphql/latest/types-q-s.md#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", + "attribute_set_id": 123, + "canonical_url": "abc123", "categories": [CategoryInterface], "color": 987, - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "created_at": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": false, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, - "id": 123, + "id": 987, "image": ProductImage, "is_returnable": "xyz789", "manufacturer": 987, @@ -1096,42 +1096,42 @@ Defines a virtual product, which is a non-tangible product that does not require "media_gallery": [MediaGalleryInterface], "media_gallery_entries": [MediaGalleryEntry], "meta_description": "xyz789", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "xyz789", - "min_sale_qty": 123.45, + "min_sale_qty": 987.65, "name": "abc123", "new_from_date": "abc123", "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", "price": ProductPrices, "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 987.65, + "quantity": 123.45, + "rating_summary": 123.45, "redirect_code": 987, "related_products": [ProductInterface], - "relative_url": "xyz789", + "relative_url": "abc123", "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_from_date": "abc123", - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "abc123", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "tier_price": 123.45, + "tier_price": 987.65, "tier_prices": [ProductTierPrices], "type": "CMS_PAGE", - "type_id": "xyz789", + "type_id": "abc123", "uid": "4", - "updated_at": "xyz789", + "updated_at": "abc123", "upsell_products": [ProductInterface], "url_key": "abc123", "url_path": "abc123", @@ -1151,8 +1151,8 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `customizable_options` - [`[CustomizableOptionInput]`](/reference/graphql/latest/types-c-e.md#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](/reference/graphql/latest/types-c-e.md#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -1173,10 +1173,10 @@ Contains details about virtual products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The amount added. | +| `uid` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1184,7 +1184,7 @@ Contains details about virtual products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" } ``` @@ -1199,12 +1199,12 @@ Contains a virtual product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -1215,7 +1215,7 @@ Contains a virtual product wish list item. "description": "abc123", "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1229,12 +1229,12 @@ Deprecated. It should not be used on the storefront. Contains information about | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](types-q-s.md#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`](types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | +| `code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](/reference/graphql/latest/types-a-b.md#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#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`](/reference/graphql/latest/types-f-i.md#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | #### Example @@ -1242,9 +1242,9 @@ Deprecated. It should not be used on the storefront. Contains information about { "code": "xyz789", "default_group_id": "abc123", - "id": 123, + "id": 987, "is_default": false, - "name": "xyz789", + "name": "abc123", "sort_order": 987 } ``` @@ -1260,14 +1260,14 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -1300,13 +1300,13 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `Wishlist` object. | +| `id` - [`ID`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `Wishlist` object. | | `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. | +| `items_count` - [`Int`](/reference/graphql/latest/types-f-i.md#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`](types-q-s.md#string) | The name of the wish list. | -| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](/reference/graphql/latest/types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The time of the last modification to the wish list. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -1315,10 +1315,10 @@ Contains a customer wish list. { "id": "4", "items": [WishlistItem], - "items_count": 987, + "items_count": 123, "items_v2": WishlistItems, "name": "xyz789", - "sharing_code": "xyz789", + "sharing_code": "abc123", "updated_at": "abc123", "visibility": "PUBLIC" } @@ -1335,9 +1335,9 @@ Contains details about errors encountered when a customer added wish list items | Field Name | Description | |------------|-------------| | `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | +| `message` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example @@ -1345,8 +1345,8 @@ Contains details about errors encountered when a customer added wish list items { "code": "PRODUCT_NOT_FOUND", "message": "xyz789", - "wishlistId": "4", - "wishlistItemId": 4 + "wishlistId": 4, + "wishlistItemId": "4" } ``` @@ -1382,21 +1382,21 @@ Contains details about a wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String`](types-q-s.md#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](types-q-s.md#string) | The customer's comment about this item. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](types-f-i.md#float) | The quantity of this wish list item | +| `added_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The customer's comment about this item. | +| `id` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this wish list item | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "description": "xyz789", "id": 987, "product": ProductInterface, - "qty": 123.45 + "qty": 987.65 } ``` @@ -1410,13 +1410,16 @@ Specifies the IDs of items to copy and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#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!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example ```json -{"quantity": 123.45, "wishlist_item_id": 4} +{ + "quantity": 123.45, + "wishlist_item_id": "4" +} ``` @@ -1429,21 +1432,21 @@ Defines the items to add to a wish list. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/latest/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](/reference/graphql/latest/types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](/reference/graphql/latest/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](/reference/graphql/latest/types-q-s.md#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, + "parent_sku": "abc123", + "quantity": 123.45, "selected_options": ["4"], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -1457,32 +1460,32 @@ The interface for wish list items. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/latest/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/latest/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](/reference/graphql/latest/types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | +| [`SimpleWishlistItem`](/reference/graphql/latest/types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | -| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | -| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | -| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](/reference/graphql/latest/types-c-e.md#configurablewishlistitem) | +| [`DownloadableWishlistItem`](/reference/graphql/latest/types-c-e.md#downloadablewishlistitem) | +| [`BundleWishlistItem`](/reference/graphql/latest/types-a-b.md#bundlewishlistitem) | +| [`GiftCardWishlistItem`](/reference/graphql/latest/types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](/reference/graphql/latest/types-f-i.md#groupedproductwishlistitem) | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": 4, "product": ProductInterface, "quantity": 123.45 @@ -1499,13 +1502,16 @@ Specifies the IDs of the items to move and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#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!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json -{"quantity": 987.65, "wishlist_item_id": 4} +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} ``` @@ -1518,19 +1524,19 @@ Defines updates to items in a wish list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `description` - [`String`](/reference/graphql/latest/types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/latest/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](/reference/graphql/latest/types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](/reference/graphql/latest/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](/reference/graphql/latest/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example ```json { - "description": "xyz789", + "description": "abc123", "entered_options": [EnteredOptionInput], - "quantity": 987.65, + "quantity": 123.45, "selected_options": [4], "wishlist_item_id": 4 } @@ -1547,7 +1553,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/latest/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example @@ -1569,10 +1575,10 @@ Deprecated: Use the `Wishlist` type instead. | 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`](types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](types-q-s.md#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`](types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | +| `items_count` - [`Int`](/reference/graphql/latest/types-f-i.md#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](/reference/graphql/latest/types-q-s.md#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`](/reference/graphql/latest/types-q-s.md#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](/reference/graphql/latest/types-q-s.md#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | #### Example @@ -1580,8 +1586,8 @@ Deprecated: Use the `Wishlist` type instead. { "items": [WishlistItem], "items_count": 987, - "name": "abc123", - "sharing_code": "abc123", + "name": "xyz789", + "sharing_code": "xyz789", "updated_at": "abc123" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md index 62fca9473..aca929f19 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md @@ -4,13 +4,13 @@ Accept invitation to the company. -**Response:** [`CompanyInvitationOutput`](types-c-e.md#companyinvitationoutput) +**Response:** [`CompanyInvitationOutput`](/reference/graphql/saas/types-c-e.md#companyinvitationoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyInvitationInput!`](types-c-e.md#companyinvitationinput) | | +| `input` - [`CompanyInvitationInput!`](/reference/graphql/saas/types-c-e.md#companyinvitationinput) | | #### Example @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": true}}} +{"data": {"acceptCompanyInvitation": {"success": false}}} ``` @@ -42,13 +42,13 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { Update an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AcceptNegotiableQuoteTemplateInput!`](types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`AcceptNegotiableQuoteTemplateInput!`](/reference/graphql/saas/types-a-b.md#acceptnegotiablequotetemplateinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -116,15 +116,15 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -134,11 +134,11 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", - "total_quantity": 987.65, + "status": "xyz789", + "template_id": 4, + "total_quantity": 123.45, "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -150,13 +150,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead. -**Response:** [`AddDownloadableProductsToCartOutput`](types-a-b.md#adddownloadableproductstocartoutput) +**Response:** [`AddDownloadableProductsToCartOutput`](/reference/graphql/saas/types-a-b.md#adddownloadableproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddDownloadableProductsToCartInput`](types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | +| `input` - [`AddDownloadableProductsToCartInput`](/reference/graphql/saas/types-a-b.md#adddownloadableproductstocartinput) | An input object that defines which downloadable products to add to the cart. | #### Example @@ -194,14 +194,14 @@ mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInpu Add registrants to the specified gift registry. -**Response:** [`AddGiftRegistryRegistrantsOutput`](types-a-b.md#addgiftregistryregistrantsoutput) +**Response:** [`AddGiftRegistryRegistrantsOutput`](/reference/graphql/saas/types-a-b.md#addgiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[AddGiftRegistryRegistrantInput!]!`](/reference/graphql/saas/types-a-b.md#addgiftregistryregistrantinput) | An array registrants to add. | #### Example @@ -250,14 +250,14 @@ mutation addGiftRegistryRegistrants( Add any type of product to the cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/saas/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The cart ID of the shopper. | -| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | +| `cartId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The cart ID of the shopper. | +| `cartItems` - [`[CartItemInput!]!`](/reference/graphql/saas/types-c-e.md#cartiteminput) | An array that defines the products to add to the cart. | #### Example @@ -286,7 +286,7 @@ mutation addProductsToCart( ```json { - "cartId": "xyz789", + "cartId": "abc123", "cartItems": [CartItemInput] } ``` @@ -310,13 +310,13 @@ mutation addProductsToCart( Add products to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/saas/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddProductsToCompareListInput`](types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | +| `input` - [`AddProductsToCompareListInput`](/reference/graphql/saas/types-a-b.md#addproductstocomparelistinput) | An input object that defines which products to add to an existing compare list. | #### Example @@ -352,7 +352,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -364,13 +364,13 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { Creates a new cart and add any type of product to it -**Response:** [`AddProductsToNewCartOutput`](types-a-b.md#addproductstonewcartoutput) +**Response:** [`AddProductsToNewCartOutput`](/reference/graphql/saas/types-a-b.md#addproductstonewcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartItems` - [`[CartItemInput!]!`](types-c-e.md#cartiteminput) | An array that defines the products to add to the new cart | +| `cartItems` - [`[CartItemInput!]!`](/reference/graphql/saas/types-c-e.md#cartiteminput) | An array that defines the products to add to the new cart | #### Example @@ -414,14 +414,14 @@ mutation addProductsToNewCart($cartItems: [CartItemInput!]!) { Add items to the specified requisition list. -**Response:** [`AddProductsToRequisitionListOutput`](types-a-b.md#addproductstorequisitionlistoutput) +**Response:** [`AddProductsToRequisitionListOutput`](/reference/graphql/saas/types-a-b.md#addproductstorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[RequisitionListItemsInput!]!`](/reference/graphql/saas/types-q-s.md#requisitionlistitemsinput) | An array of products to be added to the requisition list. | #### Example @@ -470,14 +470,14 @@ mutation addProductsToRequisitionList( Add one or more products to the specified wish list. This mutation supports all product types. -**Response:** [`AddProductsToWishlistOutput`](types-a-b.md#addproductstowishlistoutput) +**Response:** [`AddProductsToWishlistOutput`](/reference/graphql/saas/types-a-b.md#addproductstowishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemInput!]!`](types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemInput!]!`](/reference/graphql/saas/types-t-z.md#wishlistiteminput) | An array of products to add to the wish list. | #### Example @@ -530,13 +530,13 @@ mutation addProductsToWishlist( Add a comment to an existing purchase order. -**Response:** [`AddPurchaseOrderCommentOutput`](types-a-b.md#addpurchaseordercommentoutput) +**Response:** [`AddPurchaseOrderCommentOutput`](/reference/graphql/saas/types-a-b.md#addpurchaseordercommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderCommentInput!`](types-a-b.md#addpurchaseordercommentinput) | | +| `input` - [`AddPurchaseOrderCommentInput!`](/reference/graphql/saas/types-a-b.md#addpurchaseordercommentinput) | | #### Example @@ -576,13 +576,13 @@ mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) { Add purchase order items to the shopping cart. -**Response:** [`AddProductsToCartOutput`](types-a-b.md#addproductstocartoutput) +**Response:** [`AddProductsToCartOutput`](/reference/graphql/saas/types-a-b.md#addproductstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddPurchaseOrderItemsToCartInput!`](types-a-b.md#addpurchaseorderitemstocartinput) | | +| `input` - [`AddPurchaseOrderItemsToCartInput!`](/reference/graphql/saas/types-a-b.md#addpurchaseorderitemstocartinput) | | #### Example @@ -626,14 +626,14 @@ mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) Add items in the requisition list to the customer's cart. -**Response:** [`AddRequisitionListItemsToCartOutput`](types-a-b.md#addrequisitionlistitemstocartoutput) +**Response:** [`AddRequisitionListItemsToCartOutput`](/reference/graphql/saas/types-a-b.md#addrequisitionlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]`](types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]`](/reference/graphql/saas/types-f-i.md#id) | An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart. | #### Example @@ -664,7 +664,7 @@ mutation addRequisitionListItemsToCart( ```json { "requisitionListUid": "4", - "requisitionListItemUids": ["4"] + "requisitionListItemUids": [4] } ``` @@ -678,7 +678,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } } } @@ -690,13 +690,13 @@ mutation addRequisitionListItemsToCart( Add a comment to an existing return. -**Response:** [`AddReturnCommentOutput`](types-a-b.md#addreturncommentoutput) +**Response:** [`AddReturnCommentOutput`](/reference/graphql/saas/types-a-b.md#addreturncommentoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnCommentInput!`](types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | +| `input` - [`AddReturnCommentInput!`](/reference/graphql/saas/types-a-b.md#addreturncommentinput) | An input object that defines a return comment. | #### Example @@ -730,13 +730,13 @@ mutation addReturnComment($input: AddReturnCommentInput!) { Add tracking information to the return. -**Response:** [`AddReturnTrackingOutput`](types-a-b.md#addreturntrackingoutput) +**Response:** [`AddReturnTrackingOutput`](/reference/graphql/saas/types-a-b.md#addreturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AddReturnTrackingInput!`](types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | +| `input` - [`AddReturnTrackingInput!`](/reference/graphql/saas/types-a-b.md#addreturntrackinginput) | An input object that defines tracking information. | #### Example @@ -780,14 +780,14 @@ mutation addReturnTracking($input: AddReturnTrackingInput!) { Add items in the specified wishlist to the customer's cart. -**Response:** [`AddWishlistItemsToCartOutput`](types-a-b.md#addwishlistitemstocartoutput) +**Response:** [`AddWishlistItemsToCartOutput`](/reference/graphql/saas/types-a-b.md#addwishlistitemstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list | -| `wishlistItemIds` - [`[ID!]`](types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the wish list | +| `wishlistItemIds` - [`[ID!]`](/reference/graphql/saas/types-f-i.md#id) | An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart | #### Example @@ -816,7 +816,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": ["4"]} +{"wishlistId": 4, "wishlistItemIds": [4]} ``` ##### Response @@ -841,13 +841,13 @@ mutation addWishlistItemsToCart( Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/saas/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponToCartInput`](types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponToCartInput`](/reference/graphql/saas/types-a-b.md#applycoupontocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -881,13 +881,13 @@ mutation applyCouponToCart($input: ApplyCouponToCartInput) { Apply a pre-defined coupon code to the specified cart. -**Response:** [`ApplyCouponToCartOutput`](types-a-b.md#applycoupontocartoutput) +**Response:** [`ApplyCouponToCartOutput`](/reference/graphql/saas/types-a-b.md#applycoupontocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyCouponsToCartInput`](types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | +| `input` - [`ApplyCouponsToCartInput`](/reference/graphql/saas/types-a-b.md#applycouponstocartinput) | An input object that defines the coupon code to apply to the cart. | #### Example @@ -921,13 +921,13 @@ mutation applyCouponsToCart($input: ApplyCouponsToCartInput) { Apply a pre-defined gift card code to the specified cart. -**Response:** [`ApplyGiftCardToCartOutput`](types-a-b.md#applygiftcardtocartoutput) +**Response:** [`ApplyGiftCardToCartOutput`](/reference/graphql/saas/types-a-b.md#applygiftcardtocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyGiftCardToCartInput`](types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | +| `input` - [`ApplyGiftCardToCartInput`](/reference/graphql/saas/types-a-b.md#applygiftcardtocartinput) | An input object that specifies the gift card code and cart. | #### Example @@ -961,13 +961,13 @@ mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) { Apply all available points, up to the cart total. Partial redemption is not available. -**Response:** [`ApplyRewardPointsToCartOutput`](types-a-b.md#applyrewardpointstocartoutput) +**Response:** [`ApplyRewardPointsToCartOutput`](/reference/graphql/saas/types-a-b.md#applyrewardpointstocartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Example @@ -986,7 +986,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -1001,13 +1001,13 @@ mutation applyRewardPointsToCart($cartId: ID!) { Apply store credit to the specified cart. -**Response:** [`ApplyStoreCreditToCartOutput`](types-a-b.md#applystorecredittocartoutput) +**Response:** [`ApplyStoreCreditToCartOutput`](/reference/graphql/saas/types-a-b.md#applystorecredittocartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ApplyStoreCreditToCartInput!`](types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | +| `input` - [`ApplyStoreCreditToCartInput!`](/reference/graphql/saas/types-a-b.md#applystorecredittocartinput) | An input object that specifies the cart ID. | #### Example @@ -1041,13 +1041,13 @@ mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) { Approve purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/saas/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/saas/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1091,13 +1091,13 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { Assign a child company to a parent company within the company relation hierarchy. -**Response:** [`AssignChildCompanyOutput`](types-a-b.md#assignchildcompanyoutput) +**Response:** [`AssignChildCompanyOutput`](/reference/graphql/saas/types-a-b.md#assignchildcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`AssignChildCompanyInput!`](types-a-b.md#assignchildcompanyinput) | An input object that defines which companies to relate. | +| `input` - [`AssignChildCompanyInput!`](/reference/graphql/saas/types-a-b.md#assignchildcompanyinput) | An input object that defines which companies to relate. | #### Example @@ -1137,13 +1137,13 @@ mutation assignChildCompany($input: AssignChildCompanyInput!) { Assign the specified compare list to the logged in customer. -**Response:** [`AssignCompareListToCustomerOutput`](types-a-b.md#assigncomparelisttocustomeroutput) +**Response:** [`AssignCompareListToCustomerOutput`](/reference/graphql/saas/types-a-b.md#assigncomparelisttocustomeroutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be assigned. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the compare list to be assigned. | #### Example @@ -1173,7 +1173,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": true + "result": false } } } @@ -1185,13 +1185,13 @@ mutation assignCompareListToCustomer($uid: ID!) { Assign a logged-in customer to the specified guest shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -1258,7 +1258,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -1277,15 +1277,15 @@ 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, + "id": "4", "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -1301,13 +1301,13 @@ mutation assignCustomerToGuestCart($cart_id: String!) { Cancel a negotiable quote template -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelNegotiableQuoteTemplateInput!`](types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`CancelNegotiableQuoteTemplateInput!`](/reference/graphql/saas/types-c-e.md#cancelnegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -1375,29 +1375,29 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "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, - "min_order_commitment": 123, + "max_order_commitment": 987, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", - "total_quantity": 123.45, + "status": "xyz789", + "template_id": 4, + "total_quantity": 987.65, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -1409,13 +1409,13 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu Cancel the specified customer order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/saas/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CancelOrderInput!`](types-c-e.md#cancelorderinput) | | +| `input` - [`CancelOrderInput!`](/reference/graphql/saas/types-c-e.md#cancelorderinput) | | #### Example @@ -1461,13 +1461,13 @@ mutation cancelOrder($input: CancelOrderInput!) { Cancel purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/saas/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/saas/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -1511,14 +1511,14 @@ mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) { Change the password for the logged-in customer. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/saas/types-c-e.md#customer) #### Arguments | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](types-q-s.md#string) | The customer's original password. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's updated password. | +| `currentPassword` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's original password. | +| `newPassword` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's updated password. | #### Example @@ -1641,8 +1641,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "abc123", - "newPassword": "xyz789" + "currentPassword": "xyz789", + "newPassword": "abc123" } ``` @@ -1665,26 +1665,26 @@ mutation changeCustomerPassword( "date_of_birth": "xyz789", "default_billing": "xyz789", "default_shipping": "xyz789", - "email": "abc123", - "firstname": "abc123", - "gender": 987, + "email": "xyz789", + "firstname": "xyz789", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": 4, + "id": "4", "is_subscribed": false, "job_title": "xyz789", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, - "quote_enabled": false, + "purchase_orders_enabled": false, + "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1694,10 +1694,10 @@ mutation changeCustomerPassword( "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "abc123", - "taxvat": "abc123", + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -1711,13 +1711,13 @@ mutation changeCustomerPassword( Remove all items from the specified cart. -**Response:** [`ClearCustomerCartOutput`](types-c-e.md#clearcustomercartoutput) +**Response:** [`ClearCustomerCartOutput`](/reference/graphql/saas/types-c-e.md#clearcustomercartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`String!`](types-q-s.md#string) | The masked ID of the cart. | +| `cartUid` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The masked ID of the cart. | #### Example @@ -1745,7 +1745,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": true} + "clearCustomerCart": {"cart": Cart, "status": false} } } ``` @@ -1756,13 +1756,13 @@ mutation clearCustomerCart($cartUid: String!) { Remove all the products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](/reference/graphql/saas/types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of a wish list. | #### Example @@ -1784,7 +1784,7 @@ mutation clearWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": "4"} +{"wishlistId": 4} ``` ##### Response @@ -1806,13 +1806,13 @@ mutation clearWishlist($wishlistId: ID!) { Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront. -**Response:** [`CloseNegotiableQuotesOutput`](types-c-e.md#closenegotiablequotesoutput) +**Response:** [`CloseNegotiableQuotesOutput`](/reference/graphql/saas/types-c-e.md#closenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CloseNegotiableQuotesInput!`](types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | +| `input` - [`CloseNegotiableQuotesInput!`](/reference/graphql/saas/types-c-e.md#closenegotiablequotesinput) | An input object that closes a negotiable quote. | #### Example @@ -1865,13 +1865,13 @@ mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) { Synchronizes order details and place the order -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/saas/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompleteOrderInput`](types-c-e.md#completeorderinput) | Describes the variables needed to complete or place the order | +| `input` - [`CompleteOrderInput`](/reference/graphql/saas/types-c-e.md#completeorderinput) | Describes the variables needed to complete or place the order | #### Example @@ -1915,13 +1915,13 @@ mutation completeOrder($input: CompleteOrderInput) { Cancel the specified guest customer order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/saas/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmCancelOrderInput!`](types-c-e.md#confirmcancelorderinput) | | +| `input` - [`ConfirmCancelOrderInput!`](/reference/graphql/saas/types-c-e.md#confirmcancelorderinput) | | #### Example @@ -1967,13 +1967,13 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { Confirms the email address for a customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/saas/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmEmailInput!`](types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | +| `input` - [`ConfirmEmailInput!`](/reference/graphql/saas/types-c-e.md#confirmemailinput) | An input object to identify the customer to confirm the email. | #### Example @@ -2007,13 +2007,13 @@ mutation confirmEmail($input: ConfirmEmailInput!) { Confirm the return. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/saas/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ConfirmReturnInput!`](types-c-e.md#confirmreturninput) | | +| `input` - [`ConfirmReturnInput!`](/reference/graphql/saas/types-c-e.md#confirmreturninput) | | #### Example @@ -2057,13 +2057,13 @@ mutation confirmReturn($input: ConfirmReturnInput!) { Send a 'Contact Us' email to the merchant. -**Response:** [`ContactUsOutput`](types-c-e.md#contactusoutput) +**Response:** [`ContactUsOutput`](/reference/graphql/saas/types-c-e.md#contactusoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ContactUsInput!`](types-c-e.md#contactusinput) | An input object that defines shopper information. | +| `input` - [`ContactUsInput!`](/reference/graphql/saas/types-c-e.md#contactusinput) | An input object that defines shopper information. | #### Example @@ -2086,7 +2086,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": false}}} +{"data": {"contactUs": {"status": true}}} ``` @@ -2095,15 +2095,15 @@ mutation contactUs($input: ContactUsInput!) { Copy items from one requisition list to another. -**Response:** [`CopyItemsFromRequisitionListsOutput`](types-c-e.md#copyitemsfromrequisitionlistsoutput) +**Response:** [`CopyItemsFromRequisitionListsOutput`](/reference/graphql/saas/types-c-e.md#copyitemsfromrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`CopyItemsBetweenRequisitionListsInput`](/reference/graphql/saas/types-c-e.md#copyitemsbetweenrequisitionlistsinput) | The list of products to copy. | #### Example @@ -2155,15 +2155,15 @@ mutation copyItemsBetweenRequisitionLists( Copy products from one wish list to another. The original wish list is unchanged. -**Response:** [`CopyProductsBetweenWishlistsOutput`](types-c-e.md#copyproductsbetweenwishlistsoutput) +**Response:** [`CopyProductsBetweenWishlistsOutput`](/reference/graphql/saas/types-c-e.md#copyproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemCopyInput!]!`](types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemCopyInput!]!`](/reference/graphql/saas/types-t-z.md#wishlistitemcopyinput) | An array of items to copy. | #### Example @@ -2197,8 +2197,8 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", - "destinationWishlistUid": "4", + "sourceWishlistUid": 4, + "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } ``` @@ -2223,13 +2223,13 @@ mutation copyProductsBetweenWishlists( Create a company at the request of either a customer or a guest. -**Response:** [`CreateCompanyOutput`](types-c-e.md#createcompanyoutput) +**Response:** [`CreateCompanyOutput`](/reference/graphql/saas/types-c-e.md#createcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyCreateInput!`](types-c-e.md#companycreateinput) | | +| `input` - [`CompanyCreateInput!`](/reference/graphql/saas/types-c-e.md#companycreateinput) | | #### Example @@ -2263,13 +2263,13 @@ mutation createCompany($input: CompanyCreateInput!) { Create a new company role. -**Response:** [`CreateCompanyRoleOutput`](types-c-e.md#createcompanyroleoutput) +**Response:** [`CreateCompanyRoleOutput`](/reference/graphql/saas/types-c-e.md#createcompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleCreateInput!`](types-c-e.md#companyrolecreateinput) | | +| `input` - [`CompanyRoleCreateInput!`](/reference/graphql/saas/types-c-e.md#companyrolecreateinput) | | #### Example @@ -2303,13 +2303,13 @@ mutation createCompanyRole($input: CompanyRoleCreateInput!) { Create a new team for the customer's company within the current company context. -**Response:** [`CreateCompanyTeamOutput`](types-c-e.md#createcompanyteamoutput) +**Response:** [`CreateCompanyTeamOutput`](/reference/graphql/saas/types-c-e.md#createcompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamCreateInput!`](types-c-e.md#companyteamcreateinput) | | +| `input` - [`CompanyTeamCreateInput!`](/reference/graphql/saas/types-c-e.md#companyteamcreateinput) | | #### Example @@ -2343,13 +2343,13 @@ mutation createCompanyTeam($input: CompanyTeamCreateInput!) { Create a new company user at the request of an existing customer. -**Response:** [`CreateCompanyUserOutput`](types-c-e.md#createcompanyuseroutput) +**Response:** [`CreateCompanyUserOutput`](/reference/graphql/saas/types-c-e.md#createcompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserCreateInput!`](types-c-e.md#companyusercreateinput) | | +| `input` - [`CompanyUserCreateInput!`](/reference/graphql/saas/types-c-e.md#companyusercreateinput) | | #### Example @@ -2383,13 +2383,13 @@ mutation createCompanyUser($input: CompanyUserCreateInput!) { Create a new compare list. The compare list is saved for logged in customers. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/saas/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateCompareListInput`](types-c-e.md#createcomparelistinput) | | +| `input` - [`CreateCompareListInput`](/reference/graphql/saas/types-c-e.md#createcomparelistinput) | | #### Example @@ -2437,13 +2437,13 @@ mutation createCompareList($input: CreateCompareListInput) { Create a billing or shipping address for a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/saas/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerAddressInput!`](types-c-e.md#customeraddressinput) | | +| `input` - [`CustomerAddressInput!`](/reference/graphql/saas/types-c-e.md#customeraddressinput) | | #### Example @@ -2495,27 +2495,27 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { { "data": { "createCustomerAddress": { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "xyz789", - "id": 987, - "lastname": "abc123", + "fax": "xyz789", + "firstname": "abc123", + "id": 123, + "lastname": "xyz789", "middlename": "abc123", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "xyz789", "uid": 4, - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -2527,13 +2527,13 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { Create a customer account. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/saas/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerCreateInput!`](types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | +| `input` - [`CustomerCreateInput!`](/reference/graphql/saas/types-c-e.md#customercreateinput) | An input object that defines the customer to be created. | #### Example @@ -2567,13 +2567,13 @@ mutation createCustomerV2($input: CustomerCreateInput!) { Create a gift registry on behalf of the customer. -**Response:** [`CreateGiftRegistryOutput`](types-c-e.md#creategiftregistryoutput) +**Response:** [`CreateGiftRegistryOutput`](/reference/graphql/saas/types-c-e.md#creategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistry` - [`CreateGiftRegistryInput!`](types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | +| `giftRegistry` - [`CreateGiftRegistryInput!`](/reference/graphql/saas/types-c-e.md#creategiftregistryinput) | An input object that defines a new gift registry. | #### Example @@ -2611,13 +2611,13 @@ mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) { Create a new shopping cart -**Response:** [`CreateGuestCartOutput`](types-c-e.md#createguestcartoutput) +**Response:** [`CreateGuestCartOutput`](/reference/graphql/saas/types-c-e.md#createguestcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateGuestCartInput`](types-c-e.md#createguestcartinput) | | +| `input` - [`CreateGuestCartInput`](/reference/graphql/saas/types-c-e.md#createguestcartinput) | | #### Example @@ -2651,13 +2651,13 @@ mutation createGuestCart($input: CreateGuestCartInput) { Creates a payment order for further payment processing -**Response:** [`CreatePaymentOrderOutput`](types-c-e.md#createpaymentorderoutput) +**Response:** [`CreatePaymentOrderOutput`](/reference/graphql/saas/types-c-e.md#createpaymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreatePaymentOrderInput!`](types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | +| `input` - [`CreatePaymentOrderInput!`](/reference/graphql/saas/types-c-e.md#createpaymentorderinput) | Contains payment order details that are used while processing the payment order | #### Example @@ -2687,9 +2687,9 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 123.45, + "amount": 987.65, "currency_code": "xyz789", - "id": "xyz789", + "id": "abc123", "mp_order_id": "abc123", "status": "xyz789" } @@ -2703,13 +2703,13 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { Create a purchase order approval rule. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrderApprovalRuleInput!`](types-k-p.md#purchaseorderapprovalruleinput) | | +| `input` - [`PurchaseOrderApprovalRuleInput!`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalruleinput) | | #### Example @@ -2756,10 +2756,10 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "created_at": "abc123", "created_by": "abc123", "description": "xyz789", - "name": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } } } @@ -2771,13 +2771,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! Create an empty requisition list. -**Response:** [`CreateRequisitionListOutput`](types-c-e.md#createrequisitionlistoutput) +**Response:** [`CreateRequisitionListOutput`](/reference/graphql/saas/types-c-e.md#createrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateRequisitionListInput`](types-c-e.md#createrequisitionlistinput) | | +| `input` - [`CreateRequisitionListInput`](/reference/graphql/saas/types-c-e.md#createrequisitionlistinput) | | #### Example @@ -2817,13 +2817,13 @@ mutation createRequisitionList($input: CreateRequisitionListInput) { Creates a vault payment token -**Response:** [`CreateVaultCardPaymentTokenOutput`](types-c-e.md#createvaultcardpaymenttokenoutput) +**Response:** [`CreateVaultCardPaymentTokenOutput`](/reference/graphql/saas/types-c-e.md#createvaultcardpaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardPaymentTokenInput!`](types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | +| `input` - [`CreateVaultCardPaymentTokenInput!`](/reference/graphql/saas/types-c-e.md#createvaultcardpaymenttokeninput) | Describe the variables needed to create a vault card payment token | #### Example @@ -2853,7 +2853,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } } } @@ -2865,13 +2865,13 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) Creates a vault card setup token -**Response:** [`CreateVaultCardSetupTokenOutput`](types-c-e.md#createvaultcardsetuptokenoutput) +**Response:** [`CreateVaultCardSetupTokenOutput`](/reference/graphql/saas/types-c-e.md#createvaultcardsetuptokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateVaultCardSetupTokenInput!`](types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | +| `input` - [`CreateVaultCardSetupTokenInput!`](/reference/graphql/saas/types-c-e.md#createvaultcardsetuptokeninput) | Describe the variables needed to create a vault card setup token | #### Example @@ -2909,13 +2909,13 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { Create a new wish list. -**Response:** [`CreateWishlistOutput`](types-c-e.md#createwishlistoutput) +**Response:** [`CreateWishlistOutput`](/reference/graphql/saas/types-c-e.md#createwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreateWishlistInput!`](types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | +| `input` - [`CreateWishlistInput!`](/reference/graphql/saas/types-c-e.md#createwishlistinput) | An input object that defines a new wish list. | #### Example @@ -2949,13 +2949,13 @@ mutation createWishlist($input: CreateWishlistInput!) { Delete the specified company role. -**Response:** [`DeleteCompanyRoleOutput`](types-c-e.md#deletecompanyroleoutput) +**Response:** [`DeleteCompanyRoleOutput`](/reference/graphql/saas/types-c-e.md#deletecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Example @@ -2972,13 +2972,13 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyRole": {"success": true}}} +{"data": {"deleteCompanyRole": {"success": false}}} ``` @@ -2987,13 +2987,13 @@ mutation deleteCompanyRole($id: ID!) { Delete the specified company team. -**Response:** [`DeleteCompanyTeamOutput`](types-c-e.md#deletecompanyteamoutput) +**Response:** [`DeleteCompanyTeamOutput`](/reference/graphql/saas/types-c-e.md#deletecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Example @@ -3010,13 +3010,13 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": true}}} +{"data": {"deleteCompanyTeam": {"success": false}}} ``` @@ -3025,13 +3025,13 @@ mutation deleteCompanyTeam($id: ID!) { Delete the specified company user. -**Response:** [`DeleteCompanyUserOutput`](types-c-e.md#deletecompanyuseroutput) +**Response:** [`DeleteCompanyUserOutput`](/reference/graphql/saas/types-c-e.md#deletecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Example @@ -3048,13 +3048,13 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyUserV2": {"success": false}}} +{"data": {"deleteCompanyUserV2": {"success": true}}} ``` @@ -3063,13 +3063,13 @@ mutation deleteCompanyUserV2($id: ID!) { Delete the specified compare list. -**Response:** [`DeleteCompareListOutput`](types-c-e.md#deletecomparelistoutput) +**Response:** [`DeleteCompareListOutput`](/reference/graphql/saas/types-c-e.md#deletecomparelistoutput) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be deleted. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the compare list to be deleted. | #### Example @@ -3086,7 +3086,7 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -3101,7 +3101,7 @@ mutation deleteCompareList($uid: ID!) { Delete customer account -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) #### Example @@ -3129,13 +3129,13 @@ Use `deleteCustomerAddressV2` instead. Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID of the customer address to be deleted. | +| `id` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The ID of the customer address to be deleted. | #### Example @@ -3156,7 +3156,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": true}} +{"data": {"deleteCustomerAddress": false}} ``` @@ -3165,13 +3165,13 @@ mutation deleteCustomerAddress($id: Int!) { Delete the billing or shipping address of a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address to be deleted. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the customer address to be deleted. | #### Example @@ -3201,13 +3201,13 @@ mutation deleteCustomerAddressV2($uid: ID!) { Delete a negotiable quote template -**Response:** [`Boolean!`](types-a-b.md#boolean) +**Response:** [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuoteTemplateInput!`](types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | +| `input` - [`DeleteNegotiableQuoteTemplateInput!`](/reference/graphql/saas/types-c-e.md#deletenegotiablequotetemplateinput) | An input object that cancels a negotiable quote template. | #### Example @@ -3228,7 +3228,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": false}} +{"data": {"deleteNegotiableQuoteTemplate": true}} ``` @@ -3237,13 +3237,13 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu Delete a negotiable quote. The negotiable quote will not be displayed on the storefront. -**Response:** [`DeleteNegotiableQuotesOutput`](types-c-e.md#deletenegotiablequotesoutput) +**Response:** [`DeleteNegotiableQuotesOutput`](/reference/graphql/saas/types-c-e.md#deletenegotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeleteNegotiableQuotesInput!`](types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | +| `input` - [`DeleteNegotiableQuotesInput!`](/reference/graphql/saas/types-c-e.md#deletenegotiablequotesinput) | An input object that deletes a negotiable quote. | #### Example @@ -3296,13 +3296,13 @@ mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) { Delete a customer's payment token. -**Response:** [`DeletePaymentTokenOutput`](types-c-e.md#deletepaymenttokenoutput) +**Response:** [`DeletePaymentTokenOutput`](/reference/graphql/saas/types-c-e.md#deletepaymenttokenoutput) #### Arguments | Name | Description | |------|-------------| -| `public_hash` - [`String!`](types-q-s.md#string) | The reusable payment token securely stored in the vault. | +| `public_hash` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The reusable payment token securely stored in the vault. | #### Example @@ -3322,7 +3322,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "abc123"} +{"public_hash": "xyz789"} ``` ##### Response @@ -3332,7 +3332,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } } } @@ -3344,13 +3344,13 @@ mutation deletePaymentToken($public_hash: String!) { Delete existing purchase order approval rules. -**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](types-c-e.md#deletepurchaseorderapprovalruleoutput) +**Response:** [`DeletePurchaseOrderApprovalRuleOutput`](/reference/graphql/saas/types-c-e.md#deletepurchaseorderapprovalruleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](types-c-e.md#deletepurchaseorderapprovalruleinput) | | +| `input` - [`DeletePurchaseOrderApprovalRuleInput!`](/reference/graphql/saas/types-c-e.md#deletepurchaseorderapprovalruleinput) | | #### Example @@ -3390,13 +3390,13 @@ mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRule Delete a requisition list. -**Response:** [`DeleteRequisitionListOutput`](types-c-e.md#deleterequisitionlistoutput) +**Response:** [`DeleteRequisitionListOutput`](/reference/graphql/saas/types-c-e.md#deleterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -3438,14 +3438,14 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { Delete items from a requisition list. -**Response:** [`DeleteRequisitionListItemsOutput`](types-c-e.md#deleterequisitionlistitemsoutput) +**Response:** [`DeleteRequisitionListItemsOutput`](/reference/graphql/saas/types-c-e.md#deleterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItemUids` - [`[ID!]!`](types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItemUids` - [`[ID!]!`](/reference/graphql/saas/types-f-i.md#id) | An array of UIDs representing products to be removed from the requisition list. | #### Example @@ -3470,7 +3470,10 @@ mutation deleteRequisitionListItems( ##### Variables ```json -{"requisitionListUid": 4, "requisitionListItemUids": [4]} +{ + "requisitionListUid": 4, + "requisitionListItemUids": ["4"] +} ``` ##### Response @@ -3491,13 +3494,13 @@ mutation deleteRequisitionListItems( Delete the specified wish list. You cannot delete the customer's default (first) wish list. -**Response:** [`DeleteWishlistOutput`](types-c-e.md#deletewishlistoutput) +**Response:** [`DeleteWishlistOutput`](/reference/graphql/saas/types-c-e.md#deletewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to delete. | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the wish list to delete. | #### Example @@ -3517,7 +3520,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -3526,7 +3529,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": false, + "status": true, "wishlists": [Wishlist] } } @@ -3539,13 +3542,13 @@ mutation deleteWishlist($wishlistId: ID!) { Negotiable Quote resulting from duplication operation. -**Response:** [`DuplicateNegotiableQuoteOutput`](types-c-e.md#duplicatenegotiablequoteoutput) +**Response:** [`DuplicateNegotiableQuoteOutput`](/reference/graphql/saas/types-c-e.md#duplicatenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`DuplicateNegotiableQuoteInput!`](types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | +| `input` - [`DuplicateNegotiableQuoteInput!`](/reference/graphql/saas/types-c-e.md#duplicatenegotiablequoteinput) | An input object that defines ID of the quote to be duplicated. | #### Example @@ -3583,13 +3586,13 @@ mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) { Estimate shipping method(s) for cart based on address -**Response:** [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) +**Response:** [`[AvailableShippingMethod]`](/reference/graphql/saas/types-a-b.md#availableshippingmethod) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/saas/types-c-e.md#estimatetotalsinput) | An input object that specifies details for estimation of available shipping methods | #### Example @@ -3636,9 +3639,9 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "additional_data": [ShippingAdditionalData], "amount": Money, "available": false, - "carrier_code": "abc123", + "carrier_code": "xyz789", "carrier_title": "xyz789", - "error_message": "xyz789", + "error_message": "abc123", "method_code": "abc123", "method_title": "abc123", "price_excl_tax": Money, @@ -3655,13 +3658,13 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { Estimate totals for cart based on the address -**Response:** [`EstimateTotalsOutput!`](types-c-e.md#estimatetotalsoutput) +**Response:** [`EstimateTotalsOutput!`](/reference/graphql/saas/types-c-e.md#estimatetotalsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`EstimateTotalsInput!`](types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | +| `input` - [`EstimateTotalsInput!`](/reference/graphql/saas/types-c-e.md#estimatetotalsinput) | An input object that specifies details for cart totals estimation | #### Example @@ -3695,13 +3698,13 @@ mutation estimateTotals($input: EstimateTotalsInput!) { Generate a token for specified customer. -**Response:** [`ExchangeExternalCustomerTokenOutput`](types-c-e.md#exchangeexternalcustomertokenoutput) +**Response:** [`ExchangeExternalCustomerTokenOutput`](/reference/graphql/saas/types-c-e.md#exchangeexternalcustomertokenoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ExchangeExternalCustomerTokenInput`](types-c-e.md#exchangeexternalcustomertokeninput) | Contains details about external customer. | +| `input` - [`ExchangeExternalCustomerTokenInput`](/reference/graphql/saas/types-c-e.md#exchangeexternalcustomertokeninput) | Contains details about external customer. | #### Example @@ -3743,14 +3746,14 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu Exchange one time login code for customer token. -**Response:** [`CustomerToken`](types-c-e.md#customertoken) +**Response:** [`CustomerToken`](/reference/graphql/saas/types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `otp` - [`String!`](types-q-s.md#string) | The customer's OTP. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's email address. | +| `otp` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's OTP. | #### Example @@ -3785,7 +3788,7 @@ mutation exchangeOtpForCustomerToken( { "data": { "exchangeOtpForCustomerToken": { - "token": "abc123" + "token": "xyz789" } } } @@ -3795,13 +3798,13 @@ mutation exchangeOtpForCustomerToken( ### finishUpload -**Response:** [`finishUploadOutput`](types-f-i.md#finishuploadoutput) +**Response:** [`finishUploadOutput`](/reference/graphql/saas/types-f-i.md#finishuploadoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`finishUploadInput!`](types-f-i.md#finishuploadinput) | | +| `input` - [`finishUploadInput!`](/reference/graphql/saas/types-f-i.md#finishuploadinput) | | #### Example @@ -3829,8 +3832,8 @@ mutation finishUpload($input: finishUploadInput!) { { "data": { "finishUpload": { - "key": "xyz789", - "message": "xyz789", + "key": "abc123", + "message": "abc123", "success": true } } @@ -3843,14 +3846,14 @@ mutation finishUpload($input: finishUploadInput!) { Generate a token for specified customer. -**Response:** [`CustomerToken`](types-c-e.md#customertoken) +**Response:** [`CustomerToken`](/reference/graphql/saas/types-c-e.md#customertoken) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's password. | #### Example @@ -3874,8 +3877,8 @@ mutation generateCustomerToken( ```json { - "email": "xyz789", - "password": "xyz789" + "email": "abc123", + "password": "abc123" } ``` @@ -3885,7 +3888,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -3897,13 +3900,13 @@ mutation generateCustomerToken( Request a customer token so that an administrator can perform remote shopping assistance. -**Response:** [`GenerateCustomerTokenAsAdminOutput`](types-f-i.md#generatecustomertokenasadminoutput) +**Response:** [`GenerateCustomerTokenAsAdminOutput`](/reference/graphql/saas/types-f-i.md#generatecustomertokenasadminoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateCustomerTokenAsAdminInput!`](types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | +| `input` - [`GenerateCustomerTokenAsAdminInput!`](/reference/graphql/saas/types-f-i.md#generatecustomertokenasadmininput) | An input object that defines the customer email address. | #### Example @@ -3941,13 +3944,13 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! Generate a negotiable quote from an accept quote template. -**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](types-f-i.md#generatenegotiablequotefromtemplateoutput) +**Response:** [`GenerateNegotiableQuoteFromTemplateOutput`](/reference/graphql/saas/types-f-i.md#generatenegotiablequotefromtemplateoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | +| `input` - [`GenerateNegotiableQuoteFromTemplateInput!`](/reference/graphql/saas/types-f-i.md#generatenegotiablequotefromtemplateinput) | An input object that contains the data to generate a negotiable quote from quote template. | #### Example @@ -3985,13 +3988,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom Import a shared requisition list into the current customer account. -**Response:** [`ImportSharedRequisitionListOutput`](types-f-i.md#importsharedrequisitionlistoutput) +**Response:** [`ImportSharedRequisitionListOutput`](/reference/graphql/saas/types-f-i.md#importsharedrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `token` - [`String!`](types-q-s.md#string) | The token for the shared requisition list. | +| `token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The token for the shared requisition list. | #### Example @@ -4013,7 +4016,7 @@ mutation importSharedRequisitionList($token: String!) { ##### Variables ```json -{"token": "xyz789"} +{"token": "abc123"} ``` ##### Response @@ -4033,13 +4036,13 @@ mutation importSharedRequisitionList($token: String!) { ### initiateUpload -**Response:** [`initiateUploadOutput`](types-f-i.md#initiateuploadoutput) +**Response:** [`initiateUploadOutput`](/reference/graphql/saas/types-f-i.md#initiateuploadoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`initiateUploadInput!`](types-f-i.md#initiateuploadinput) | | +| `input` - [`initiateUploadInput!`](/reference/graphql/saas/types-f-i.md#initiateuploadinput) | | #### Example @@ -4067,9 +4070,9 @@ mutation initiateUpload($input: initiateUploadInput!) { { "data": { "initiateUpload": { - "expires_at": "abc123", - "key": "abc123", - "upload_url": "abc123" + "expires_at": "xyz789", + "key": "xyz789", + "upload_url": "xyz789" } } } @@ -4081,14 +4084,14 @@ mutation initiateUpload($input: initiateUploadInput!) { Transfer the contents of a guest cart into the cart of a logged-in customer. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](types-q-s.md#string) | The guest's cart ID before they login. | -| `destination_cart_id` - [`String`](types-q-s.md#string) | The cart ID after the guest logs in. | +| `source_cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The guest's cart ID before they login. | +| `destination_cart_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The cart ID after the guest logs in. | #### Example @@ -4163,7 +4166,7 @@ mutation mergeCarts( ```json { "source_cart_id": "xyz789", - "destination_cart_id": "abc123" + "destination_cart_id": "xyz789" } ``` @@ -4183,7 +4186,7 @@ mutation mergeCarts( ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, @@ -4191,7 +4194,7 @@ mutation mergeCarts( "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -4207,14 +4210,14 @@ mutation mergeCarts( Move all items from the cart to a gift registry. -**Response:** [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) +**Response:** [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/saas/types-k-p.md#movecartitemstogiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `cartUid` - [`ID!`](types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the target gift registry. | +| `cartUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the cart containing items to be moved to a gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the target gift registry. | #### Example @@ -4243,7 +4246,10 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": "4", "giftRegistryUid": 4} +{ + "cartUid": "4", + "giftRegistryUid": "4" +} ``` ##### Response @@ -4253,7 +4259,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } } @@ -4266,15 +4272,15 @@ mutation moveCartItemsToGiftRegistry( Move Items from one requisition list to another. -**Response:** [`MoveItemsBetweenRequisitionListsOutput`](types-k-p.md#moveitemsbetweenrequisitionlistsoutput) +**Response:** [`MoveItemsBetweenRequisitionListsOutput`](/reference/graphql/saas/types-k-p.md#moveitemsbetweenrequisitionlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceRequisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the source requisition list. | -| `destinationRequisitionListUid` - [`ID`](types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | -| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | +| `sourceRequisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the source requisition list. | +| `destinationRequisitionListUid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the destination requisition list. If null, a new requisition list will be created. | +| `requisitionListItem` - [`MoveItemsBetweenRequisitionListsInput`](/reference/graphql/saas/types-k-p.md#moveitemsbetweenrequisitionlistsinput) | The list of products to move. | #### Example @@ -4305,8 +4311,8 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": 4, + "sourceRequisitionListUid": 4, + "destinationRequisitionListUid": "4", "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4330,13 +4336,13 @@ mutation moveItemsBetweenRequisitionLists( Move negotiable quote item to requisition list. -**Response:** [`MoveLineItemToRequisitionListOutput`](types-k-p.md#movelineitemtorequisitionlistoutput) +**Response:** [`MoveLineItemToRequisitionListOutput`](/reference/graphql/saas/types-k-p.md#movelineitemtorequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`MoveLineItemToRequisitionListInput!`](types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | +| `input` - [`MoveLineItemToRequisitionListInput!`](/reference/graphql/saas/types-k-p.md#movelineitemtorequisitionlistinput) | An input object that defines the quote item and requisition list moved to. | #### Example @@ -4376,15 +4382,15 @@ mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInpu Move products from one wish list to another. -**Response:** [`MoveProductsBetweenWishlistsOutput`](types-k-p.md#moveproductsbetweenwishlistsoutput) +**Response:** [`MoveProductsBetweenWishlistsOutput`](/reference/graphql/saas/types-k-p.md#moveproductsbetweenwishlistsoutput) #### Arguments | Name | Description | |------|-------------| -| `sourceWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the original wish list. | -| `destinationWishlistUid` - [`ID!`](types-f-i.md#id) | The ID of the target wish list. | -| `wishlistItems` - [`[WishlistItemMoveInput!]!`](types-t-z.md#wishlistitemmoveinput) | An array of items to move. | +| `sourceWishlistUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the original wish list. | +| `destinationWishlistUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the target wish list. | +| `wishlistItems` - [`[WishlistItemMoveInput!]!`](/reference/graphql/saas/types-t-z.md#wishlistitemmoveinput) | An array of items to move. | #### Example @@ -4444,13 +4450,13 @@ mutation moveProductsBetweenWishlists( Open an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OpenNegotiableQuoteTemplateInput!`](types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | +| `input` - [`OpenNegotiableQuoteTemplateInput!`](/reference/graphql/saas/types-k-p.md#opennegotiablequotetemplateinput) | An input object that contains the data to open a negotiable quote template. | #### Example @@ -4517,30 +4523,30 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, - "total_quantity": 123.45, + "template_id": "4", + "total_quantity": 987.65, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -4556,13 +4562,13 @@ Use placeNegotiableQuoteOrderV2 instead. Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutput`](types-k-p.md#placenegotiablequoteorderoutput) +**Response:** [`PlaceNegotiableQuoteOrderOutput`](/reference/graphql/saas/types-k-p.md#placenegotiablequoteorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](/reference/graphql/saas/types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4596,13 +4602,13 @@ mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) { Convert a negotiable quote into an order. -**Response:** [`PlaceNegotiableQuoteOrderOutputV2`](types-k-p.md#placenegotiablequoteorderoutputv2) +**Response:** [`PlaceNegotiableQuoteOrderOutputV2`](/reference/graphql/saas/types-k-p.md#placenegotiablequoteorderoutputv2) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceNegotiableQuoteOrderInput!`](types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | +| `input` - [`PlaceNegotiableQuoteOrderInput!`](/reference/graphql/saas/types-k-p.md#placenegotiablequoteorderinput) | An input object that specifies the negotiable quote. | #### Example @@ -4646,13 +4652,13 @@ mutation placeNegotiableQuoteOrderV2($input: PlaceNegotiableQuoteOrderInput!) { Convert the quote into an order. -**Response:** [`PlaceOrderOutput`](types-k-p.md#placeorderoutput) +**Response:** [`PlaceOrderOutput`](/reference/graphql/saas/types-k-p.md#placeorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](/reference/graphql/saas/types-k-p.md#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4696,13 +4702,13 @@ mutation placeOrder($input: PlaceOrderInput) { Convert the purchase order into an order. -**Response:** [`PlaceOrderForPurchaseOrderOutput`](types-k-p.md#placeorderforpurchaseorderoutput) +**Response:** [`PlaceOrderForPurchaseOrderOutput`](/reference/graphql/saas/types-k-p.md#placeorderforpurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlaceOrderForPurchaseOrderInput!`](types-k-p.md#placeorderforpurchaseorderinput) | | +| `input` - [`PlaceOrderForPurchaseOrderInput!`](/reference/graphql/saas/types-k-p.md#placeorderforpurchaseorderinput) | | #### Example @@ -4740,13 +4746,13 @@ mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) { Place a purchase order. -**Response:** [`PlacePurchaseOrderOutput`](types-k-p.md#placepurchaseorderoutput) +**Response:** [`PlacePurchaseOrderOutput`](/reference/graphql/saas/types-k-p.md#placepurchaseorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PlacePurchaseOrderInput!`](types-k-p.md#placepurchaseorderinput) | | +| `input` - [`PlacePurchaseOrderInput!`](/reference/graphql/saas/types-k-p.md#placepurchaseorderinput) | | #### Example @@ -4786,13 +4792,13 @@ mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) { Redeem a gift card for store credit. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/saas/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/saas/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code to redeem. | #### Example @@ -4823,7 +4829,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "xyz789" } } @@ -4836,13 +4842,13 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { Reject purchase orders. -**Response:** [`PurchaseOrdersActionOutput`](types-k-p.md#purchaseordersactionoutput) +**Response:** [`PurchaseOrdersActionOutput`](/reference/graphql/saas/types-k-p.md#purchaseordersactionoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`PurchaseOrdersActionInput!`](types-k-p.md#purchaseordersactioninput) | | +| `input` - [`PurchaseOrdersActionInput!`](/reference/graphql/saas/types-k-p.md#purchaseordersactioninput) | | #### Example @@ -4886,13 +4892,13 @@ mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/saas/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponFromCartInput`](types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponFromCartInput`](/reference/graphql/saas/types-q-s.md#removecouponfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4926,13 +4932,13 @@ mutation removeCouponFromCart($input: RemoveCouponFromCartInput) { Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon. -**Response:** [`RemoveCouponFromCartOutput`](types-q-s.md#removecouponfromcartoutput) +**Response:** [`RemoveCouponFromCartOutput`](/reference/graphql/saas/types-q-s.md#removecouponfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveCouponsFromCartInput`](types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | +| `input` - [`RemoveCouponsFromCartInput`](/reference/graphql/saas/types-q-s.md#removecouponsfromcartinput) | An input object that defines which coupon code to remove from the cart. | #### Example @@ -4966,13 +4972,13 @@ mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) { Removes a gift card from the cart. -**Response:** [`RemoveGiftCardFromCartOutput`](types-q-s.md#removegiftcardfromcartoutput) +**Response:** [`RemoveGiftCardFromCartOutput`](/reference/graphql/saas/types-q-s.md#removegiftcardfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveGiftCardFromCartInput`](types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | +| `input` - [`RemoveGiftCardFromCartInput`](/reference/graphql/saas/types-q-s.md#removegiftcardfromcartinput) | An input object that specifies which gift card code to remove from the cart. | #### Example @@ -5006,13 +5012,13 @@ mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) { Delete the specified gift registry. -**Response:** [`RemoveGiftRegistryOutput`](types-q-s.md#removegiftregistryoutput) +**Response:** [`RemoveGiftRegistryOutput`](/reference/graphql/saas/types-q-s.md#removegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry to delete. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry to delete. | #### Example @@ -5035,7 +5041,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Response ```json -{"data": {"removeGiftRegistry": {"success": true}}} +{"data": {"removeGiftRegistry": {"success": false}}} ``` @@ -5044,14 +5050,14 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { Delete the specified items from a gift registry. -**Response:** [`RemoveGiftRegistryItemsOutput`](types-q-s.md#removegiftregistryitemsoutput) +**Response:** [`RemoveGiftRegistryItemsOutput`](/reference/graphql/saas/types-q-s.md#removegiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `itemsUid` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs to remove from the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry. | +| `itemsUid` - [`[ID!]!`](/reference/graphql/saas/types-f-i.md#id) | An array of item IDs to remove from the gift registry. | #### Example @@ -5100,14 +5106,14 @@ mutation removeGiftRegistryItems( Removes registrants from a gift registry. -**Response:** [`RemoveGiftRegistryRegistrantsOutput`](types-q-s.md#removegiftregistryregistrantsoutput) +**Response:** [`RemoveGiftRegistryRegistrantsOutput`](/reference/graphql/saas/types-q-s.md#removegiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrantsUid` - [`[ID!]!`](types-f-i.md#id) | An array of registrant IDs to remove. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrantsUid` - [`[ID!]!`](/reference/graphql/saas/types-f-i.md#id) | An array of registrant IDs to remove. | #### Example @@ -5133,8 +5139,8 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", - "registrantsUid": [4] + "giftRegistryUid": 4, + "registrantsUid": ["4"] } ``` @@ -5156,13 +5162,13 @@ mutation removeGiftRegistryRegistrants( Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist. -**Response:** [`RemoveItemFromCartOutput`](types-q-s.md#removeitemfromcartoutput) +**Response:** [`RemoveItemFromCartOutput`](/reference/graphql/saas/types-q-s.md#removeitemfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveItemFromCartInput`](types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | +| `input` - [`RemoveItemFromCartInput`](/reference/graphql/saas/types-q-s.md#removeitemfromcartinput) | An input object that defines which products to remove from the cart. | #### Example @@ -5196,13 +5202,13 @@ mutation removeItemFromCart($input: RemoveItemFromCartInput) { Remove one or more products from a negotiable quote. -**Response:** [`RemoveNegotiableQuoteItemsOutput`](types-q-s.md#removenegotiablequoteitemsoutput) +**Response:** [`RemoveNegotiableQuoteItemsOutput`](/reference/graphql/saas/types-q-s.md#removenegotiablequoteitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteItemsInput!`](types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | +| `input` - [`RemoveNegotiableQuoteItemsInput!`](/reference/graphql/saas/types-q-s.md#removenegotiablequoteitemsinput) | An input object that removes one or more items from a negotiable quote. | #### Example @@ -5242,13 +5248,13 @@ mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) { Remove one or more products from a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | +| `input` - [`RemoveNegotiableQuoteTemplateItemsInput!`](/reference/graphql/saas/types-q-s.md#removenegotiablequotetemplateitemsinput) | An input object that removes one or more items from a negotiable quote template. | #### Example @@ -5315,29 +5321,29 @@ 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_virtual": true, + "is_min_max_qty_used": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 123, + "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 ], "status": "abc123", - "template_id": "4", - "total_quantity": 987.65, - "uid": "4", + "template_id": 4, + "total_quantity": 123.45, + "uid": 4, "updated_at": "xyz789" } } @@ -5350,13 +5356,13 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat Remove products from the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/saas/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveProductsFromCompareListInput`](types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | +| `input` - [`RemoveProductsFromCompareListInput`](/reference/graphql/saas/types-q-s.md#removeproductsfromcomparelistinput) | An input object that defines which products to remove from a compare list. | #### Example @@ -5390,9 +5396,9 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -5404,14 +5410,14 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu Remove one or more products from the specified wish list. -**Response:** [`RemoveProductsFromWishlistOutput`](types-q-s.md#removeproductsfromwishlistoutput) +**Response:** [`RemoveProductsFromWishlistOutput`](/reference/graphql/saas/types-q-s.md#removeproductsfromwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItemsIds` - [`[ID!]!`](types-f-i.md#id) | An array of item IDs representing products to be removed. | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItemsIds` - [`[ID!]!`](/reference/graphql/saas/types-f-i.md#id) | An array of item IDs representing products to be removed. | #### Example @@ -5439,7 +5445,10 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": ["4"]} +{ + "wishlistId": "4", + "wishlistItemsIds": ["4"] +} ``` ##### Response @@ -5461,13 +5470,13 @@ mutation removeProductsFromWishlist( Remove a tracked shipment from a return. -**Response:** [`RemoveReturnTrackingOutput`](types-q-s.md#removereturntrackingoutput) +**Response:** [`RemoveReturnTrackingOutput`](/reference/graphql/saas/types-q-s.md#removereturntrackingoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveReturnTrackingInput!`](types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | +| `input` - [`RemoveReturnTrackingInput!`](/reference/graphql/saas/types-q-s.md#removereturntrackinginput) | An input object that removes tracking information. | #### Example @@ -5501,13 +5510,13 @@ mutation removeReturnTracking($input: RemoveReturnTrackingInput!) { Cancel the application of reward points to the cart. -**Response:** [`RemoveRewardPointsFromCartOutput`](types-q-s.md#removerewardpointsfromcartoutput) +**Response:** [`RemoveRewardPointsFromCartOutput`](/reference/graphql/saas/types-q-s.md#removerewardpointsfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`ID!`](types-f-i.md#id) | | +| `cartId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Example @@ -5541,13 +5550,13 @@ mutation removeRewardPointsFromCart($cartId: ID!) { Remove store credit that has been applied to the specified cart. -**Response:** [`RemoveStoreCreditFromCartOutput`](types-q-s.md#removestorecreditfromcartoutput) +**Response:** [`RemoveStoreCreditFromCartOutput`](/reference/graphql/saas/types-q-s.md#removestorecreditfromcartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RemoveStoreCreditFromCartInput!`](types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | +| `input` - [`RemoveStoreCreditFromCartInput!`](/reference/graphql/saas/types-q-s.md#removestorecreditfromcartinput) | An input object that specifies the cart ID. | #### Example @@ -5581,13 +5590,13 @@ mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) { Rename negotiable quote. -**Response:** [`RenameNegotiableQuoteOutput`](types-q-s.md#renamenegotiablequoteoutput) +**Response:** [`RenameNegotiableQuoteOutput`](/reference/graphql/saas/types-q-s.md#renamenegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RenameNegotiableQuoteInput!`](types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | +| `input` - [`RenameNegotiableQuoteInput!`](/reference/graphql/saas/types-q-s.md#renamenegotiablequoteinput) | An input object that defines the quote item name and comment. | #### Example @@ -5625,13 +5634,13 @@ mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) { Add all products from a customer's previous order to the cart. -**Response:** [`ReorderItemsOutput`](types-q-s.md#reorderitemsoutput) +**Response:** [`ReorderItemsOutput`](/reference/graphql/saas/types-q-s.md#reorderitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `orderNumber` - [`String!`](types-q-s.md#string) | | +| `orderNumber` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -5653,7 +5662,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "abc123"} +{"orderNumber": "xyz789"} ``` ##### Response @@ -5675,13 +5684,13 @@ mutation reorderItems($orderNumber: String!) { Request to cancel specified guest order. -**Response:** [`CancelOrderOutput`](types-c-e.md#cancelorderoutput) +**Response:** [`CancelOrderOutput`](/reference/graphql/saas/types-c-e.md#cancelorderoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderCancelInput!`](types-f-i.md#guestordercancelinput) | | +| `input` - [`GuestOrderCancelInput!`](/reference/graphql/saas/types-f-i.md#guestordercancelinput) | | #### Example @@ -5713,7 +5722,7 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { { "data": { "requestGuestOrderCancel": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -5725,13 +5734,13 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { ### requestGuestReturn -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/saas/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestGuestReturnInput!`](types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | +| `input` - [`RequestGuestReturnInput!`](/reference/graphql/saas/types-q-s.md#requestguestreturninput) | An input object that contains the fields needed to start a return request for guest. | #### Example @@ -5775,13 +5784,13 @@ mutation requestGuestReturn($input: RequestGuestReturnInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`RequestNegotiableQuoteOutput`](types-q-s.md#requestnegotiablequoteoutput) +**Response:** [`RequestNegotiableQuoteOutput`](/reference/graphql/saas/types-q-s.md#requestnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteInput!`](types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | +| `input` - [`RequestNegotiableQuoteInput!`](/reference/graphql/saas/types-q-s.md#requestnegotiablequoteinput) | An input object that contains a request to initiate a negotiable quote. | #### Example @@ -5819,13 +5828,13 @@ mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) { Request a new negotiable quote on behalf of the buyer. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestNegotiableQuoteTemplateInput!`](types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | +| `input` - [`RequestNegotiableQuoteTemplateInput!`](/reference/graphql/saas/types-q-s.md#requestnegotiablequotetemplateinput) | An input object that contains a request to initiate a negotiable quote template. | #### Example @@ -5892,30 +5901,30 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "requestNegotiableQuoteTemplateFromQuote": { "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": false, - "is_virtual": false, + "is_min_max_qty_used": true, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, + "max_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", - "total_quantity": 123.45, - "uid": 4, - "updated_at": "xyz789" + "status": "xyz789", + "template_id": 4, + "total_quantity": 987.65, + "uid": "4", + "updated_at": "abc123" } } } @@ -5927,13 +5936,13 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT Request an email with a reset password token for the registered customer identified by the specified email. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's email address. | #### Example @@ -5948,13 +5957,13 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"requestPasswordResetEmail": false}} +{"data": {"requestPasswordResetEmail": true}} ``` @@ -5963,13 +5972,13 @@ mutation requestPasswordResetEmail($email: String!) { Initiates a buyer's request to return items for replacement or refund. -**Response:** [`RequestReturnOutput`](types-q-s.md#requestreturnoutput) +**Response:** [`RequestReturnOutput`](/reference/graphql/saas/types-q-s.md#requestreturnoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`RequestReturnInput!`](types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | +| `input` - [`RequestReturnInput!`](/reference/graphql/saas/types-q-s.md#requestreturninput) | An input object that contains the fields needed to start a return request. | #### Example @@ -6013,13 +6022,13 @@ mutation requestReturn($input: RequestReturnInput!) { Resends the confirmation email to a customer. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to send the confirmation email to. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address to send the confirmation email to. | #### Example @@ -6034,7 +6043,7 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -6049,15 +6058,15 @@ mutation resendConfirmationEmail($email: String!) { Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`. -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](types-q-s.md#string) | The customer's new password. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's new password. | #### Example @@ -6099,7 +6108,7 @@ mutation resetPassword( Revoke the customer token. -**Response:** [`RevokeCustomerTokenOutput`](types-q-s.md#revokecustomertokenoutput) +**Response:** [`RevokeCustomerTokenOutput`](/reference/graphql/saas/types-q-s.md#revokecustomertokenoutput) #### Example @@ -6116,7 +6125,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": false}}} +{"data": {"revokeCustomerToken": {"result": true}}} ``` @@ -6125,13 +6134,13 @@ mutation revokeCustomerToken { Send the negotiable quote to the seller for review. -**Response:** [`SendNegotiableQuoteForReviewOutput`](types-q-s.md#sendnegotiablequoteforreviewoutput) +**Response:** [`SendNegotiableQuoteForReviewOutput`](/reference/graphql/saas/types-q-s.md#sendnegotiablequoteforreviewoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SendNegotiableQuoteForReviewInput!`](types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | +| `input` - [`SendNegotiableQuoteForReviewInput!`](/reference/graphql/saas/types-q-s.md#sendnegotiablequoteforreviewinput) | An input object that sends a request for the merchant to review a negotiable quote. | #### Example @@ -6171,13 +6180,13 @@ mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput! Set the billing address on a specific cart. -**Response:** [`SetBillingAddressOnCartOutput`](types-q-s.md#setbillingaddressoncartoutput) +**Response:** [`SetBillingAddressOnCartOutput`](/reference/graphql/saas/types-q-s.md#setbillingaddressoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetBillingAddressOnCartInput`](types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | +| `input` - [`SetBillingAddressOnCartInput`](/reference/graphql/saas/types-q-s.md#setbillingaddressoncartinput) | An input object that defines the billing address to be assigned to the cart. | #### Example @@ -6211,13 +6220,13 @@ mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) { Sets the cart as inactive -**Response:** [`SetCartAsInactiveOutput`](types-q-s.md#setcartasinactiveoutput) +**Response:** [`SetCartAsInactiveOutput`](/reference/graphql/saas/types-q-s.md#setcartasinactiveoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | +| `cartId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer cart ID | #### Example @@ -6244,7 +6253,7 @@ mutation setCartAsInactive($cartId: String!) { { "data": { "setCartAsInactive": { - "error": "abc123", + "error": "xyz789", "success": false } } @@ -6257,13 +6266,13 @@ mutation setCartAsInactive($cartId: String!) { Add custom attributes to the cart. -**Response:** [`AddCustomAttributesToCartItemOutput`](types-a-b.md#addcustomattributestocartitemoutput) +**Response:** [`AddCustomAttributesToCartItemOutput`](/reference/graphql/saas/types-a-b.md#addcustomattributestocartitemoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CartCustomAttributesInput`](types-c-e.md#cartcustomattributesinput) | | +| `input` - [`CartCustomAttributesInput`](/reference/graphql/saas/types-c-e.md#cartcustomattributesinput) | | #### Example @@ -6297,13 +6306,13 @@ mutation setCustomAttributesOnCart($input: CartCustomAttributesInput) { Add custom attributes to item in the cart. -**Response:** [`AddCustomAttributesToCartItemOutput`](types-a-b.md#addcustomattributestocartitemoutput) +**Response:** [`AddCustomAttributesToCartItemOutput`](/reference/graphql/saas/types-a-b.md#addcustomattributestocartitemoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CartItemCustomAttributesInput`](types-c-e.md#cartitemcustomattributesinput) | | +| `input` - [`CartItemCustomAttributesInput`](/reference/graphql/saas/types-c-e.md#cartitemcustomattributesinput) | | #### Example @@ -6341,13 +6350,13 @@ mutation setCustomAttributesOnCartItem($input: CartItemCustomAttributesInput) { Add custom attributes to company. -**Response:** [`SetCustomAttributesOnCompanyOutput`](types-q-s.md#setcustomattributesoncompanyoutput) +**Response:** [`SetCustomAttributesOnCompanyOutput`](/reference/graphql/saas/types-q-s.md#setcustomattributesoncompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetCustomAttributesOnCompanyInput!`](types-q-s.md#setcustomattributesoncompanyinput) | An input object that defines the custom attributes to be assigned to a company. | +| `input` - [`SetCustomAttributesOnCompanyInput!`](/reference/graphql/saas/types-q-s.md#setcustomattributesoncompanyinput) | An input object that defines the custom attributes to be assigned to a company. | #### Example @@ -6385,13 +6394,13 @@ mutation setCustomAttributesOnCompany($input: SetCustomAttributesOnCompanyInput! Add custom attributes to the credit memo. -**Response:** [`CreditMemoOutput`](types-c-e.md#creditmemooutput) +**Response:** [`CreditMemoOutput`](/reference/graphql/saas/types-c-e.md#creditmemooutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreditMemoCustomAttributesInput`](types-c-e.md#creditmemocustomattributesinput) | | +| `input` - [`CreditMemoCustomAttributesInput`](/reference/graphql/saas/types-c-e.md#creditmemocustomattributesinput) | | #### Example @@ -6431,13 +6440,13 @@ mutation setCustomAttributesOnCreditMemo($input: CreditMemoCustomAttributesInput Add custom attributes to the credit memo item. -**Response:** [`CreditMemoOutput`](types-c-e.md#creditmemooutput) +**Response:** [`CreditMemoOutput`](/reference/graphql/saas/types-c-e.md#creditmemooutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CreditMemoItemCustomAttributesInput`](types-c-e.md#creditmemoitemcustomattributesinput) | | +| `input` - [`CreditMemoItemCustomAttributesInput`](/reference/graphql/saas/types-c-e.md#creditmemoitemcustomattributesinput) | | #### Example @@ -6477,13 +6486,13 @@ mutation setCustomAttributesOnCreditMemoItem($input: CreditMemoItemCustomAttribu Add custom attributes to the invoice. -**Response:** [`InvoiceOutput`](types-f-i.md#invoiceoutput) +**Response:** [`InvoiceOutput`](/reference/graphql/saas/types-f-i.md#invoiceoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`InvoiceCustomAttributesInput`](types-f-i.md#invoicecustomattributesinput) | | +| `input` - [`InvoiceCustomAttributesInput`](/reference/graphql/saas/types-f-i.md#invoicecustomattributesinput) | | #### Example @@ -6521,13 +6530,13 @@ mutation setCustomAttributesOnInvoice($input: InvoiceCustomAttributesInput) { Add custom attributes to the invoice item. -**Response:** [`InvoiceOutput`](types-f-i.md#invoiceoutput) +**Response:** [`InvoiceOutput`](/reference/graphql/saas/types-f-i.md#invoiceoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`InvoiceItemCustomAttributesInput`](types-f-i.md#invoiceitemcustomattributesinput) | | +| `input` - [`InvoiceItemCustomAttributesInput`](/reference/graphql/saas/types-f-i.md#invoiceitemcustomattributesinput) | | #### Example @@ -6567,13 +6576,13 @@ mutation setCustomAttributesOnInvoiceItem($input: InvoiceItemCustomAttributesInp Add custom attributes to a negotiable quote. -**Response:** [`SetCustomAttributesOnNegotiableQuoteOutput`](types-q-s.md#setcustomattributesonnegotiablequoteoutput) +**Response:** [`SetCustomAttributesOnNegotiableQuoteOutput`](/reference/graphql/saas/types-q-s.md#setcustomattributesonnegotiablequoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetCustomAttributesOnNegotiableQuoteInput!`](types-q-s.md#setcustomattributesonnegotiablequoteinput) | An input object that defines the custom attributes to be assigned to a negotiable quote. | +| `input` - [`SetCustomAttributesOnNegotiableQuoteInput!`](/reference/graphql/saas/types-q-s.md#setcustomattributesonnegotiablequoteinput) | An input object that defines the custom attributes to be assigned to a negotiable quote. | #### Example @@ -6613,13 +6622,13 @@ mutation setCustomAttributesOnNegotiableQuote($input: SetCustomAttributesOnNegot Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards. -**Response:** [`SetGiftOptionsOnCartOutput`](types-q-s.md#setgiftoptionsoncartoutput) +**Response:** [`SetGiftOptionsOnCartOutput`](/reference/graphql/saas/types-q-s.md#setgiftoptionsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGiftOptionsOnCartInput`](types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | +| `input` - [`SetGiftOptionsOnCartInput`](/reference/graphql/saas/types-q-s.md#setgiftoptionsoncartinput) | An input object that defines the selected gift options. | #### Example @@ -6653,13 +6662,13 @@ mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) { Assign the email address of a guest to the cart. -**Response:** [`SetGuestEmailOnCartOutput`](types-q-s.md#setguestemailoncartoutput) +**Response:** [`SetGuestEmailOnCartOutput`](/reference/graphql/saas/types-q-s.md#setguestemailoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetGuestEmailOnCartInput`](types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | +| `input` - [`SetGuestEmailOnCartInput`](/reference/graphql/saas/types-q-s.md#setguestemailoncartinput) | An input object that defines a guest email address. | #### Example @@ -6693,13 +6702,13 @@ mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) { Add buyer's note to a negotiable quote item. -**Response:** [`SetLineItemNoteOutput`](types-q-s.md#setlineitemnoteoutput) +**Response:** [`SetLineItemNoteOutput`](/reference/graphql/saas/types-q-s.md#setlineitemnoteoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`LineItemNoteInput!`](types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | +| `input` - [`LineItemNoteInput!`](/reference/graphql/saas/types-k-p.md#lineitemnoteinput) | An input object that defines the quote item note. | #### Example @@ -6733,13 +6742,13 @@ mutation setLineItemNote($input: LineItemNoteInput!) { Assign a billing address to a negotiable quote. -**Response:** [`SetNegotiableQuoteBillingAddressOutput`](types-q-s.md#setnegotiablequotebillingaddressoutput) +**Response:** [`SetNegotiableQuoteBillingAddressOutput`](/reference/graphql/saas/types-q-s.md#setnegotiablequotebillingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteBillingAddressInput!`](types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteBillingAddressInput!`](/reference/graphql/saas/types-q-s.md#setnegotiablequotebillingaddressinput) | An input object that defines the billing address to be assigned to a negotiable quote. | #### Example @@ -6779,13 +6788,13 @@ mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddre Set the payment method on a negotiable quote. -**Response:** [`SetNegotiableQuotePaymentMethodOutput`](types-q-s.md#setnegotiablequotepaymentmethodoutput) +**Response:** [`SetNegotiableQuotePaymentMethodOutput`](/reference/graphql/saas/types-q-s.md#setnegotiablequotepaymentmethodoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuotePaymentMethodInput!`](types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | +| `input` - [`SetNegotiableQuotePaymentMethodInput!`](/reference/graphql/saas/types-q-s.md#setnegotiablequotepaymentmethodinput) | An input object that defines the payment method for the specified negotiable quote. | #### Example @@ -6825,13 +6834,13 @@ mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethod Assign a previously-defined address as the shipping address for a negotiable quote. -**Response:** [`SetNegotiableQuoteShippingAddressOutput`](types-q-s.md#setnegotiablequoteshippingaddressoutput) +**Response:** [`SetNegotiableQuoteShippingAddressOutput`](/reference/graphql/saas/types-q-s.md#setnegotiablequoteshippingaddressoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingAddressInput!`](types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingAddressInput!`](/reference/graphql/saas/types-q-s.md#setnegotiablequoteshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote. | #### Example @@ -6871,13 +6880,13 @@ mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAdd Assign the shipping methods on the negotiable quote. -**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](types-q-s.md#setnegotiablequoteshippingmethodsoutput) +**Response:** [`SetNegotiableQuoteShippingMethodsOutput`](/reference/graphql/saas/types-q-s.md#setnegotiablequoteshippingmethodsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | +| `input` - [`SetNegotiableQuoteShippingMethodsInput!`](/reference/graphql/saas/types-q-s.md#setnegotiablequoteshippingmethodsinput) | An input object that defines the shipping methods to be assigned to a negotiable quote. | #### Example @@ -6917,13 +6926,13 @@ mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMet Assign a previously-defined address as the shipping address for a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | +| `input` - [`SetNegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/saas/types-q-s.md#setnegotiablequotetemplateshippingaddressinput) | An input object that defines the shipping address to be assigned to a negotiable quote template. | #### Example @@ -6990,16 +6999,16 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "expiration_date": "abc123", + "created_at": "xyz789", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "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": [ @@ -7010,10 +7019,10 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", + "template_id": 4, "total_quantity": 123.45, - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } } } @@ -7025,13 +7034,13 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem Apply a payment method to the cart. -**Response:** [`SetPaymentMethodOnCartOutput`](types-q-s.md#setpaymentmethodoncartoutput) +**Response:** [`SetPaymentMethodOnCartOutput`](/reference/graphql/saas/types-q-s.md#setpaymentmethodoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetPaymentMethodOnCartInput`](types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | +| `input` - [`SetPaymentMethodOnCartInput`](/reference/graphql/saas/types-q-s.md#setpaymentmethodoncartinput) | An input object that defines which payment method to apply to the cart. | #### Example @@ -7065,13 +7074,13 @@ mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) { Set expiration date to a negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateExpirationDateInput!`](types-q-s.md#quotetemplateexpirationdateinput) | An input object that defines the quote template expiration date. | +| `input` - [`QuoteTemplateExpirationDateInput!`](/reference/graphql/saas/types-q-s.md#quotetemplateexpirationdateinput) | An input object that defines the quote template expiration date. | #### Example @@ -7143,25 +7152,25 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", - "total_quantity": 123.45, + "template_id": 4, + "total_quantity": 987.65, "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -7173,13 +7182,13 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput Add buyer's note to a negotiable quote template item. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`QuoteTemplateLineItemNoteInput!`](types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | +| `input` - [`QuoteTemplateLineItemNoteInput!`](/reference/graphql/saas/types-q-s.md#quotetemplatelineitemnoteinput) | An input object that defines the quote template item note. | #### Example @@ -7246,11 +7255,11 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "setQuoteTemplateLineItemNote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "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": 987, @@ -7261,14 +7270,14 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", "template_id": "4", "total_quantity": 123.45, - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -7281,13 +7290,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { Set one or more shipping addresses on a specific cart. -**Response:** [`SetShippingAddressesOnCartOutput`](types-q-s.md#setshippingaddressesoncartoutput) +**Response:** [`SetShippingAddressesOnCartOutput`](/reference/graphql/saas/types-q-s.md#setshippingaddressesoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingAddressesOnCartInput`](types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | +| `input` - [`SetShippingAddressesOnCartInput`](/reference/graphql/saas/types-q-s.md#setshippingaddressesoncartinput) | An input object that defines one or more shipping addresses to be assigned to the cart. | #### Example @@ -7321,13 +7330,13 @@ mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) { Set one or more delivery methods on a cart. -**Response:** [`SetShippingMethodsOnCartOutput`](types-q-s.md#setshippingmethodsoncartoutput) +**Response:** [`SetShippingMethodsOnCartOutput`](/reference/graphql/saas/types-q-s.md#setshippingmethodsoncartoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SetShippingMethodsOnCartInput`](types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | +| `input` - [`SetShippingMethodsOnCartInput`](/reference/graphql/saas/types-q-s.md#setshippingmethodsoncartinput) | An input object that applies one or more shipping methods to the cart. | #### Example @@ -7361,15 +7370,15 @@ mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) { Send an email about the gift registry to a list of invitees. -**Response:** [`ShareGiftRegistryOutput`](types-q-s.md#sharegiftregistryoutput) +**Response:** [`ShareGiftRegistryOutput`](/reference/graphql/saas/types-q-s.md#sharegiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | -| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry. | +| `sender` - [`ShareGiftRegistrySenderInput!`](/reference/graphql/saas/types-q-s.md#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](/reference/graphql/saas/types-q-s.md#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7395,7 +7404,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7413,13 +7422,13 @@ mutation shareGiftRegistry( Share a requisition list with company colleagues via email using a secure link. -**Response:** [`ShareRequisitionListByEmailOutput`](types-q-s.md#sharerequisitionlistbyemailoutput) +**Response:** [`ShareRequisitionListByEmailOutput`](/reference/graphql/saas/types-q-s.md#sharerequisitionlistbyemailoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ShareRequisitionListByEmailInput!`](types-q-s.md#sharerequisitionlistbyemailinput) | | +| `input` - [`ShareRequisitionListByEmailInput!`](/reference/graphql/saas/types-q-s.md#sharerequisitionlistbyemailinput) | | #### Example @@ -7448,7 +7457,7 @@ mutation shareRequisitionListByEmail($input: ShareRequisitionListByEmailInput!) { "data": { "shareRequisitionListByEmail": { - "sent_count": 987, + "sent_count": 123, "user_errors": [ShareRequisitionListUserError] } } @@ -7461,13 +7470,13 @@ mutation shareRequisitionListByEmail($input: ShareRequisitionListByEmailInput!) Share a requisition list by issuing a token for colleagues in the same company. Use the token to build a shareable link on the storefront. -**Response:** [`ShareRequisitionListByTokenOutput`](types-q-s.md#sharerequisitionlistbytokenoutput) +**Response:** [`ShareRequisitionListByTokenOutput`](/reference/graphql/saas/types-q-s.md#sharerequisitionlistbytokenoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -7484,7 +7493,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": "4"} +{"requisitionListUid": 4} ``` ##### Response @@ -7505,13 +7514,13 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { Accept an existing negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | +| `input` - [`SubmitNegotiableQuoteTemplateForReviewInput!`](/reference/graphql/saas/types-q-s.md#submitnegotiablequotetemplateforreviewinput) | An input object that contains the data to update a negotiable quote template. | #### Example @@ -7578,28 +7587,28 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "submitNegotiableQuoteTemplateForReview": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": false, + "is_min_max_qty_used": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": 4, "updated_at": "abc123" } @@ -7613,13 +7622,13 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem Subscribe the specified email to the store's newsletter. -**Response:** [`SubscribeEmailToNewsletterOutput`](types-q-s.md#subscribeemailtonewsletteroutput) +**Response:** [`SubscribeEmailToNewsletterOutput`](/reference/graphql/saas/types-q-s.md#subscribeemailtonewsletteroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address that will receive the store's newsletter. | #### Example @@ -7651,13 +7660,13 @@ mutation subscribeEmailToNewsletter($email: String!) { Subscribe logged-in customer to price alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](/reference/graphql/saas/types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertPriceInput!`](types-k-p.md#productalertpriceinput) | | +| `input` - [`ProductAlertPriceInput!`](/reference/graphql/saas/types-k-p.md#productalertpriceinput) | | #### Example @@ -7685,7 +7694,7 @@ mutation subscribeProductAlertPrice($input: ProductAlertPriceInput!) { "data": { "subscribeProductAlertPrice": { "message": "abc123", - "success": false + "success": true } } } @@ -7697,13 +7706,13 @@ mutation subscribeProductAlertPrice($input: ProductAlertPriceInput!) { Subscribe logged-in customer to stock alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](/reference/graphql/saas/types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertStockInput!`](types-k-p.md#productalertstockinput) | | +| `input` - [`ProductAlertStockInput!`](/reference/graphql/saas/types-k-p.md#productalertstockinput) | | #### Example @@ -7743,13 +7752,13 @@ mutation subscribeProductAlertStock($input: ProductAlertStockInput!) { Synchronizes the payment order details for further payment processing -**Response:** [`Boolean`](types-a-b.md#boolean) +**Response:** [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) #### Arguments | Name | Description | |------|-------------| -| `input` - [`SyncPaymentOrderInput`](types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | +| `input` - [`SyncPaymentOrderInput`](/reference/graphql/saas/types-q-s.md#syncpaymentorderinput) | Describes the variables needed to synchronize the payment order details | #### Example @@ -7779,13 +7788,13 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { Unassign a child company from its parent company within the company relation hierarchy. -**Response:** [`UnassignChildCompanyOutput`](types-t-z.md#unassignchildcompanyoutput) +**Response:** [`UnassignChildCompanyOutput`](/reference/graphql/saas/types-t-z.md#unassignchildcompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UnassignChildCompanyInput!`](types-t-z.md#unassignchildcompanyinput) | An input object that defines which company to unassign. | +| `input` - [`UnassignChildCompanyInput!`](/reference/graphql/saas/types-t-z.md#unassignchildcompanyinput) | An input object that defines which company to unassign. | #### Example @@ -7825,13 +7834,13 @@ mutation unassignChildCompany($input: UnassignChildCompanyInput!) { Unsubscribe logged-in customer to price alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](/reference/graphql/saas/types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertPriceInput!`](types-k-p.md#productalertpriceinput) | | +| `input` - [`ProductAlertPriceInput!`](/reference/graphql/saas/types-k-p.md#productalertpriceinput) | | #### Example @@ -7859,7 +7868,7 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { "data": { "unsubscribeProductAlertPrice": { "message": "xyz789", - "success": false + "success": true } } } @@ -7871,7 +7880,7 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { Unsubscribe logged-in customer to price alert for all product. -**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](/reference/graphql/saas/types-k-p.md#productalertsubscriptionresult) #### Example @@ -7892,7 +7901,7 @@ mutation unsubscribeProductAlertPriceAll { { "data": { "unsubscribeProductAlertPriceAll": { - "message": "xyz789", + "message": "abc123", "success": true } } @@ -7905,13 +7914,13 @@ mutation unsubscribeProductAlertPriceAll { Unsubscribe logged-in customer to stock alert for a product. -**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](/reference/graphql/saas/types-k-p.md#productalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertStockInput!`](types-k-p.md#productalertstockinput) | | +| `input` - [`ProductAlertStockInput!`](/reference/graphql/saas/types-k-p.md#productalertstockinput) | | #### Example @@ -7939,7 +7948,7 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { "data": { "unsubscribeProductAlertStock": { "message": "xyz789", - "success": false + "success": true } } } @@ -7951,7 +7960,7 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { Unsubscribe logged-in customer to stock alert for all product. -**Response:** [`ProductAlertSubscriptionResult`](types-k-p.md#productalertsubscriptionresult) +**Response:** [`ProductAlertSubscriptionResult`](/reference/graphql/saas/types-k-p.md#productalertsubscriptionresult) #### Example @@ -7973,7 +7982,7 @@ mutation unsubscribeProductAlertStockAll { "data": { "unsubscribeProductAlertStockAll": { "message": "xyz789", - "success": false + "success": true } } } @@ -7985,13 +7994,13 @@ mutation unsubscribeProductAlertStockAll { Modify items in the cart. -**Response:** [`UpdateCartItemsOutput`](types-t-z.md#updatecartitemsoutput) +**Response:** [`UpdateCartItemsOutput`](/reference/graphql/saas/types-t-z.md#updatecartitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateCartItemsInput`](types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | +| `input` - [`UpdateCartItemsInput`](/reference/graphql/saas/types-t-z.md#updatecartitemsinput) | An input object that defines products to be updated. | #### Example @@ -8035,13 +8044,13 @@ mutation updateCartItems($input: UpdateCartItemsInput) { Update company information. -**Response:** [`UpdateCompanyOutput`](types-t-z.md#updatecompanyoutput) +**Response:** [`UpdateCompanyOutput`](/reference/graphql/saas/types-t-z.md#updatecompanyoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUpdateInput!`](types-c-e.md#companyupdateinput) | | +| `input` - [`CompanyUpdateInput!`](/reference/graphql/saas/types-c-e.md#companyupdateinput) | | #### Example @@ -8075,13 +8084,13 @@ mutation updateCompany($input: CompanyUpdateInput!) { Update company role information. -**Response:** [`UpdateCompanyRoleOutput`](types-t-z.md#updatecompanyroleoutput) +**Response:** [`UpdateCompanyRoleOutput`](/reference/graphql/saas/types-t-z.md#updatecompanyroleoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyRoleUpdateInput!`](types-c-e.md#companyroleupdateinput) | | +| `input` - [`CompanyRoleUpdateInput!`](/reference/graphql/saas/types-c-e.md#companyroleupdateinput) | | #### Example @@ -8115,13 +8124,13 @@ mutation updateCompanyRole($input: CompanyRoleUpdateInput!) { Change the parent node of a company team within the current company context. -**Response:** [`UpdateCompanyStructureOutput`](types-t-z.md#updatecompanystructureoutput) +**Response:** [`UpdateCompanyStructureOutput`](/reference/graphql/saas/types-t-z.md#updatecompanystructureoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyStructureUpdateInput!`](types-c-e.md#companystructureupdateinput) | | +| `input` - [`CompanyStructureUpdateInput!`](/reference/graphql/saas/types-c-e.md#companystructureupdateinput) | | #### Example @@ -8155,13 +8164,13 @@ mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) { Update company team data. -**Response:** [`UpdateCompanyTeamOutput`](types-t-z.md#updatecompanyteamoutput) +**Response:** [`UpdateCompanyTeamOutput`](/reference/graphql/saas/types-t-z.md#updatecompanyteamoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyTeamUpdateInput!`](types-c-e.md#companyteamupdateinput) | | +| `input` - [`CompanyTeamUpdateInput!`](/reference/graphql/saas/types-c-e.md#companyteamupdateinput) | | #### Example @@ -8195,13 +8204,13 @@ mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) { Update an existing company user. -**Response:** [`UpdateCompanyUserOutput`](types-t-z.md#updatecompanyuseroutput) +**Response:** [`UpdateCompanyUserOutput`](/reference/graphql/saas/types-t-z.md#updatecompanyuseroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CompanyUserUpdateInput!`](types-c-e.md#companyuserupdateinput) | | +| `input` - [`CompanyUserUpdateInput!`](/reference/graphql/saas/types-c-e.md#companyuserupdateinput) | | #### Example @@ -8239,14 +8248,14 @@ Use `updateCustomerAddressV2` instead. Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/saas/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `id` - [`Int!`](types-f-i.md#int) | The ID assigned to the customer address. | -| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | +| `id` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The ID assigned to the customer address. | +| `input` - [`CustomerAddressInput`](/reference/graphql/saas/types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -8304,26 +8313,26 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "xyz789", "id": 987, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "uid": "4", + "suffix": "xyz789", + "telephone": "xyz789", + "uid": 4, "vat_id": "abc123" } } @@ -8336,14 +8345,14 @@ mutation updateCustomerAddress( Update the billing or shipping address of a customer or guest. -**Response:** [`CustomerAddress`](types-c-e.md#customeraddress) +**Response:** [`CustomerAddress`](/reference/graphql/saas/types-c-e.md#customeraddress) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the customer address. | -| `input` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the customer address. | +| `input` - [`CustomerAddressInput`](/reference/graphql/saas/types-c-e.md#customeraddressinput) | An input object that contains changes to the customer address. | #### Example @@ -8392,7 +8401,10 @@ mutation updateCustomerAddressV2( ##### Variables ```json -{"uid": 4, "input": CustomerAddressInput} +{ + "uid": "4", + "input": CustomerAddressInput +} ``` ##### Response @@ -8401,25 +8413,25 @@ mutation updateCustomerAddressV2( { "data": { "updateCustomerAddressV2": { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": true, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "xyz789", "id": 987, "lastname": "abc123", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", + "region_id": 123, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", "uid": 4, "vat_id": "xyz789" } @@ -8433,14 +8445,14 @@ mutation updateCustomerAddressV2( Change the email address for the logged-in customer. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/saas/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `password` - [`String!`](types-q-s.md#string) | The customer's password. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's email address. | +| `password` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's password. | #### Example @@ -8466,8 +8478,8 @@ mutation updateCustomerEmail( ```json { - "email": "xyz789", - "password": "xyz789" + "email": "abc123", + "password": "abc123" } ``` @@ -8483,13 +8495,13 @@ mutation updateCustomerEmail( Update the customer's personal information. -**Response:** [`CustomerOutput`](types-c-e.md#customeroutput) +**Response:** [`CustomerOutput`](/reference/graphql/saas/types-c-e.md#customeroutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`CustomerUpdateInput!`](types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | +| `input` - [`CustomerUpdateInput!`](/reference/graphql/saas/types-c-e.md#customerupdateinput) | An input object that defines the customer characteristics to update. | #### Example @@ -8523,14 +8535,14 @@ mutation updateCustomerV2($input: CustomerUpdateInput!) { Update the specified gift registry. -**Response:** [`UpdateGiftRegistryOutput`](types-t-z.md#updategiftregistryoutput) +**Response:** [`UpdateGiftRegistryOutput`](/reference/graphql/saas/types-t-z.md#updategiftregistryoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of an existing gift registry. | -| `giftRegistry` - [`UpdateGiftRegistryInput!`](types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an existing gift registry. | +| `giftRegistry` - [`UpdateGiftRegistryInput!`](/reference/graphql/saas/types-t-z.md#updategiftregistryinput) | An input object that defines which fields to update. | #### Example @@ -8556,7 +8568,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "giftRegistry": UpdateGiftRegistryInput } ``` @@ -8577,14 +8589,14 @@ mutation updateGiftRegistry( Update the specified items in the gift registry. -**Response:** [`UpdateGiftRegistryItemsOutput`](types-t-z.md#updategiftregistryitemsoutput) +**Response:** [`UpdateGiftRegistryItemsOutput`](/reference/graphql/saas/types-t-z.md#updategiftregistryitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `items` - [`[UpdateGiftRegistryItemInput!]!`](types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry. | +| `items` - [`[UpdateGiftRegistryItemInput!]!`](/reference/graphql/saas/types-t-z.md#updategiftregistryiteminput) | An array of items to be updated. | #### Example @@ -8633,14 +8645,14 @@ mutation updateGiftRegistryItems( Modify the properties of one or more gift registry registrants. -**Response:** [`UpdateGiftRegistryRegistrantsOutput`](types-t-z.md#updategiftregistryregistrantsoutput) +**Response:** [`UpdateGiftRegistryRegistrantsOutput`](/reference/graphql/saas/types-t-z.md#updategiftregistryregistrantsoutput) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | -| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry. | +| `registrants` - [`[UpdateGiftRegistryRegistrantInput!]!`](/reference/graphql/saas/types-t-z.md#updategiftregistryregistrantinput) | An array of registrants to update. | #### Example @@ -8666,7 +8678,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -8689,13 +8701,13 @@ mutation updateGiftRegistryRegistrants( Change the quantity of one or more items in an existing negotiable quote. -**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](types-t-z.md#updatenegotiablequoteitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteItemsQuantityOutput`](/reference/graphql/saas/types-t-z.md#updatenegotiablequoteitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | +| `input` - [`UpdateNegotiableQuoteQuantitiesInput!`](/reference/graphql/saas/types-t-z.md#updatenegotiablequotequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote. | #### Example @@ -8735,13 +8747,13 @@ mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantities Change the quantity of one or more items in an existing negotiable quote template. -**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) +**Response:** [`UpdateNegotiableQuoteTemplateItemsQuantityOutput`](/reference/graphql/saas/types-t-z.md#updatenegotiablequotetemplateitemsquantityoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | +| `input` - [`UpdateNegotiableQuoteTemplateQuantitiesInput!`](/reference/graphql/saas/types-t-z.md#updatenegotiablequotetemplatequantitiesinput) | An input object that changes the quantity of one or more items in a negotiable quote template. | #### Example @@ -8781,14 +8793,14 @@ mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTe Update one or more products in the specified wish list. -**Response:** [`UpdateProductsInWishlistOutput`](types-t-z.md#updateproductsinwishlistoutput) +**Response:** [`UpdateProductsInWishlistOutput`](/reference/graphql/saas/types-t-z.md#updateproductsinwishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of a wish list. | -| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of a wish list. | +| `wishlistItems` - [`[WishlistItemUpdateInput!]!`](/reference/graphql/saas/types-t-z.md#wishlistitemupdateinput) | An array of items to be updated. | #### Example @@ -8841,13 +8853,13 @@ mutation updateProductsInWishlist( Update existing purchase order approval rules. -**Response:** [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) +**Response:** [`PurchaseOrderApprovalRule`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalrule) #### Arguments | Name | Description | |------|-------------| -| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](types-t-z.md#updatepurchaseorderapprovalruleinput) | | +| `input` - [`UpdatePurchaseOrderApprovalRuleInput!`](/reference/graphql/saas/types-t-z.md#updatepurchaseorderapprovalruleinput) | | #### Example @@ -8893,11 +8905,11 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "xyz789", "created_by": "xyz789", - "description": "abc123", + "description": "xyz789", "name": "abc123", "status": "ENABLED", - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } } } @@ -8909,14 +8921,14 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule Rename a requisition list and change its description. -**Response:** [`UpdateRequisitionListOutput`](types-t-z.md#updaterequisitionlistoutput) +**Response:** [`UpdateRequisitionListOutput`](/reference/graphql/saas/types-t-z.md#updaterequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `input` - [`UpdateRequisitionListInput`](types-t-z.md#updaterequisitionlistinput) | | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | +| `input` - [`UpdateRequisitionListInput`](/reference/graphql/saas/types-t-z.md#updaterequisitionlistinput) | | #### Example @@ -8965,14 +8977,14 @@ mutation updateRequisitionList( Update items in a requisition list. -**Response:** [`UpdateRequisitionListItemsOutput`](types-t-z.md#updaterequisitionlistitemsoutput) +**Response:** [`UpdateRequisitionListItemsOutput`](/reference/graphql/saas/types-t-z.md#updaterequisitionlistitemsoutput) #### Arguments | Name | Description | |------|-------------| -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | -| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | +| `requisitionListItems` - [`[UpdateRequisitionListItemsInput!]!`](/reference/graphql/saas/types-t-z.md#updaterequisitionlistitemsinput) | Items to be updated in the requisition list. | #### Example @@ -9023,15 +9035,15 @@ mutation updateRequisitionListItems( Change the name and visibility of the specified wish list. -**Response:** [`UpdateWishlistOutput`](types-t-z.md#updatewishlistoutput) +**Response:** [`UpdateWishlistOutput`](/reference/graphql/saas/types-t-z.md#updatewishlistoutput) #### Arguments | Name | Description | |------|-------------| -| `wishlistId` - [`ID!`](types-f-i.md#id) | The ID of the wish list to update. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the wish list. | -| `visibility` - [`WishlistVisibilityEnum`](types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the wish list to update. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name assigned to the wish list. | +| `visibility` - [`WishlistVisibilityEnum`](/reference/graphql/saas/types-t-z.md#wishlistvisibilityenum) | Indicates the visibility of the wish list. | #### Example @@ -9085,13 +9097,13 @@ mutation updateWishlist( Validate purchase orders. -**Response:** [`ValidatePurchaseOrdersOutput`](types-t-z.md#validatepurchaseordersoutput) +**Response:** [`ValidatePurchaseOrdersOutput`](/reference/graphql/saas/types-t-z.md#validatepurchaseordersoutput) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ValidatePurchaseOrdersInput!`](types-t-z.md#validatepurchaseordersinput) | | +| `input` - [`ValidatePurchaseOrdersInput!`](/reference/graphql/saas/types-t-z.md#validatepurchaseordersinput) | | #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-saas-queries.md b/src/pages/includes/autogenerated/graphql-api-saas-queries.md index 07e189457..4ef3c8600 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-queries.md @@ -20,7 +20,7 @@ SaaS Return a list of product attribute codes that can be used for sorting or filtering in a `productSearch` query -**Response:** [`AttributeMetadataResponse!`](types-a-b.md#attributemetadataresponse) +**Response:** [`AttributeMetadataResponse!`](/reference/graphql/saas/types-a-b.md#attributemetadataresponse) #### Example @@ -58,13 +58,13 @@ query attributeMetadata { Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options. -**Response:** [`AttributesFormOutput!`](types-a-b.md#attributesformoutput) +**Response:** [`AttributesFormOutput!`](/reference/graphql/saas/types-a-b.md#attributesformoutput) #### Arguments | Name | Description | |------|-------------| -| `formCode` - [`String!`](types-q-s.md#string) | Form code. | +| `formCode` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Form code. | #### Example @@ -108,14 +108,14 @@ query attributesForm($formCode: String!) { Returns a list of attributes metadata for a given entity type. -**Response:** [`AttributesMetadataOutput`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput`](/reference/graphql/saas/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `entityType` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | Entity type. | -| `filters` - [`AttributeFilterInput`](types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | +| `entityType` - [`AttributeEntityTypeEnum!`](/reference/graphql/saas/types-a-b.md#attributeentitytypeenum) | Entity type. | +| `filters` - [`AttributeFilterInput`](/reference/graphql/saas/types-a-b.md#attributefilterinput) | Identifies which filter inputs to search for and return. | #### Example @@ -168,13 +168,13 @@ query attributesList( Get a list of available store views and their config information. -**Response:** [`[StoreConfig]`](types-q-s.md#storeconfig) +**Response:** [`[StoreConfig]`](/reference/graphql/saas/types-q-s.md#storeconfig) #### Arguments | Name | Description | |------|-------------| -| `useCurrentGroup` - [`Boolean`](types-a-b.md#boolean) | Filter store views by the current store group. | +| `useCurrentGroup` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Filter store views by the current store group. | #### Example @@ -350,22 +350,22 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "allow_company_registration": false, - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "abc123", + "allow_company_registration": true, + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "xyz789", "allow_items": "xyz789", - "allow_order": "xyz789", + "allow_order": "abc123", "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", + "base_currency_code": "abc123", "base_link_url": "xyz789", - "base_media_url": "abc123", - "base_static_url": "xyz789", + "base_media_url": "xyz789", + "base_static_url": "abc123", "base_url": "abc123", - "cart_expires_in_days": 123, - "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "xyz789", + "cart_expires_in_days": 987, + "cart_gift_wrapping": "abc123", + "cart_merge_preference": "abc123", "cart_printed_card": "abc123", "cart_summary_display_quantity": 987, "catalog_default_sort_by": "abc123", @@ -375,129 +375,129 @@ 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": "abc123", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", + "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", - "company_credit_enabled": true, + "check_money_order_title": "xyz789", + "company_credit_enabled": false, "company_enabled": true, "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", + "configurable_thumbnail_source": "xyz789", "contact_enabled": true, - "countries_with_required_region": "abc123", + "countries_with_required_region": "xyz789", "create_account_confirmation": true, - "customer_access_token_lifetime": 123.45, - "default_country": "xyz789", - "default_display_currency_code": "abc123", + "customer_access_token_lifetime": 987.65, + "default_country": "abc123", + "default_display_currency_code": "xyz789", "display_product_prices_in_catalog": 987, "display_shipping_prices": 987, "display_state_if_optional": true, "enable_multiple_wishlists": "xyz789", - "fixed_product_taxes_apply_tax_to_fpt": true, - "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 123, - "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 123, - "fixed_product_taxes_enable": false, - "fixed_product_taxes_include_fpt_in_subtotal": false, - "graphql_share_customer_group": false, + "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": 987, + "fixed_product_taxes_enable": true, + "fixed_product_taxes_include_fpt_in_subtotal": true, + "graphql_share_customer_group": true, "grid_per_page": 123, - "grid_per_page_values": "xyz789", + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": true, + "is_checkout_agreements_enabled": false, "is_default_store": true, "is_default_store_group": false, "is_guest_checkout_enabled": false, "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": true, + "is_one_page_checkout_enabled": false, "is_requisition_list_active": "abc123", - "list_mode": "abc123", - "list_per_page": 987, + "list_mode": "xyz789", + "list_per_page": 123, "list_per_page_values": "xyz789", "locale": "xyz789", - "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "abc123", - "magento_reward_general_min_points_balance": "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": "abc123", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "abc123", "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "abc123", "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "xyz789", + "magento_reward_points_review": "abc123", "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "xyz789", "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "xyz789", + "maximum_number_of_wishlists": "abc123", "minicart_display": true, "minicart_max_items": 123, "minimum_password_length": "abc123", - "newsletter_enabled": true, - "optional_zip_countries": "xyz789", + "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": 123, - "orders_invoices_credit_memos_display_shipping_amount": 987, - "orders_invoices_credit_memos_display_subtotal": 123, - "orders_invoices_credit_memos_display_zero_tax": true, + "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": 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": false, "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "xyz789", "required_character_classes_number": "abc123", - "requisition_list_share_link_validity_days": 987, - "requisition_list_share_max_recipients": 123, + "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": "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", "secure_base_link_url": "xyz789", - "secure_base_media_url": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "abc123", "share_active_segments": false, - "share_applied_cart_rule": true, - "shopping_assistance_checkbox_title": "xyz789", - "shopping_assistance_checkbox_tooltip": "xyz789", + "share_applied_cart_rule": false, + "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": true, + "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_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": "abc123", - "title_separator": "xyz789", + "title_separator": "abc123", "use_store_in_url": true, "website_code": "4", - "website_name": "xyz789", - "weight_unit": "xyz789", + "website_name": "abc123", + "weight_unit": "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": "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" } ] } @@ -510,13 +510,13 @@ query availableStores($useCurrentGroup: Boolean) { Return information about the specified shopping cart. -**Response:** [`Cart`](types-c-e.md#cart) +**Response:** [`Cart`](/reference/graphql/saas/types-c-e.md#cart) #### Arguments | Name | Description | |------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -583,7 +583,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -602,7 +602,7 @@ query cart($cart_id: String!) { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, @@ -610,11 +610,11 @@ query cart($cart_id: String!) { "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -630,15 +630,15 @@ This field is deprecated and will be removed. Return category views by IDs, with optional role filters and subtree scopes. In Adobe Commerce as a Cloud Service, this query replaces the `categories` query defined in the Commerce Foundation. -**Response:** [`[CategoryView]`](types-c-e.md#categoryview) +**Response:** [`[CategoryView]`](/reference/graphql/saas/types-c-e.md#categoryview) #### Arguments | Name | Description | |------|-------------| -| `ids` - [`[String!]`](types-q-s.md#string) | List of category IDs to retrieve. For example, `123`, `456` or `789`. | -| `roles` - [`[String!]`](types-q-s.md#string) | List of roles to filter the categories by. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | -| `subtree` - [`Subtree`](types-q-s.md#subtree) | Subtree of the categories to retrieve. `startLevel` uses absolute category levels (root = 1). For example, `depth: 1`, `startLevel: 1`. | +| `ids` - [`[String!]`](/reference/graphql/saas/types-q-s.md#string) | List of category IDs to retrieve. For example, `123`, `456` or `789`. | +| `roles` - [`[String!]`](/reference/graphql/saas/types-q-s.md#string) | List of roles to filter the categories by. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `subtree` - [`Subtree`](/reference/graphql/saas/types-q-s.md#subtree) | Subtree of the categories to retrieve. `startLevel` uses absolute category levels (root = 1). For example, `depth: 1`, `startLevel: 1`. | #### Example @@ -677,7 +677,7 @@ query categories( ```json { - "ids": ["abc123"], + "ids": ["xyz789"], "roles": ["xyz789"], "subtree": Subtree } @@ -696,14 +696,14 @@ query categories( "id": 4, "level": 987, "name": "abc123", - "parentId": "xyz789", + "parentId": "abc123", "position": 987, "path": "abc123", - "roles": ["xyz789"], - "urlKey": "abc123", + "roles": ["abc123"], + "urlKey": "xyz789", "urlPath": "abc123", "count": 987, - "title": "abc123" + "title": "xyz789" } ] } @@ -716,7 +716,7 @@ query categories( Return Terms and Conditions configuration information. -**Response:** [`[CheckoutAgreement]`](types-c-e.md#checkoutagreement) +**Response:** [`[CheckoutAgreement]`](/reference/graphql/saas/types-c-e.md#checkoutagreement) #### Example @@ -744,12 +744,12 @@ query checkoutAgreements { "checkoutAgreements": [ { "agreement_id": 123, - "checkbox_text": "abc123", + "checkbox_text": "xyz789", "content": "abc123", - "content_height": "abc123", + "content_height": "xyz789", "is_html": false, "mode": "AUTO", - "name": "xyz789" + "name": "abc123" } ] } @@ -762,7 +762,7 @@ query checkoutAgreements { Provide necessary information to build headless storefront when Adobe Commerce is connected to Commerce Optimizer. -**Response:** [`CommerceOptimizerContext!`](types-c-e.md#commerceoptimizercontext) +**Response:** [`CommerceOptimizerContext!`](/reference/graphql/saas/types-c-e.md#commerceoptimizercontext) #### Example @@ -794,7 +794,7 @@ query commerceOptimizer { Return detailed information about the customer's company within the current company context. -**Response:** [`Company`](types-c-e.md#company) +**Response:** [`Company`](/reference/graphql/saas/types-c-e.md#company) #### Example @@ -881,8 +881,8 @@ query company { "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "xyz789", - "payment_methods": ["xyz789"], + "name": "abc123", + "payment_methods": ["abc123"], "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, @@ -892,7 +892,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } } } @@ -904,13 +904,13 @@ query company { Return products that have been added to the specified compare list. -**Response:** [`CompareList`](types-c-e.md#comparelist) +**Response:** [`CompareList`](/reference/graphql/saas/types-c-e.md#comparelist) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the compare list to be queried. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the compare list to be queried. | #### Example @@ -934,7 +934,7 @@ query compareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -944,9 +944,9 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -958,7 +958,7 @@ query compareList($uid: ID!) { The countries query provides information for all countries. -**Response:** [`[Country]`](types-c-e.md#country) +**Response:** [`[Country]`](/reference/graphql/saas/types-c-e.md#country) #### Example @@ -988,8 +988,8 @@ query countries { { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "xyz789", + "full_name_locale": "xyz789", + "id": "abc123", "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" } @@ -1004,13 +1004,13 @@ query countries { The countries query provides information for a single country. -**Response:** [`Country`](types-c-e.md#country) +**Response:** [`Country`](/reference/graphql/saas/types-c-e.md#country) #### Arguments | Name | Description | |------|-------------| -| `id` - [`String`](types-q-s.md#string) | | +| `id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -1044,9 +1044,9 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "xyz789", + "full_name_english": "abc123", "full_name_locale": "xyz789", - "id": "abc123", + "id": "xyz789", "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "abc123" } @@ -1060,7 +1060,7 @@ query country($id: String) { Return information about the store's currency. -**Response:** [`Currency`](types-c-e.md#currency) +**Response:** [`Currency`](/reference/graphql/saas/types-c-e.md#currency) #### Example @@ -1092,7 +1092,7 @@ query currency { ], "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } @@ -1106,13 +1106,13 @@ query currency { Retrieve EAV attributes metadata. -**Response:** [`AttributesMetadataOutput!`](types-a-b.md#attributesmetadataoutput) +**Response:** [`AttributesMetadataOutput!`](/reference/graphql/saas/types-a-b.md#attributesmetadataoutput) #### Arguments | Name | Description | |------|-------------| -| `attributes` - [`[AttributeInput!]`](types-a-b.md#attributeinput) | | +| `attributes` - [`[AttributeInput!]`](/reference/graphql/saas/types-a-b.md#attributeinput) | | #### Example @@ -1156,7 +1156,7 @@ query customAttributeMetadataV2($attributes: [AttributeInput!]) { Return detailed information about a customer account. -**Response:** [`Customer`](types-c-e.md#customer) +**Response:** [`Customer`](/reference/graphql/saas/types-c-e.md#customer) #### Example @@ -1283,21 +1283,21 @@ query customer { "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", + "date_of_birth": "abc123", + "default_billing": "xyz789", "default_shipping": "xyz789", "email": "xyz789", - "firstname": "abc123", - "gender": 987, + "firstname": "xyz789", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": 4, - "is_subscribed": true, + "id": "4", + "is_subscribed": false, "job_title": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", "orders": CustomerOrders, "prefix": "xyz789", @@ -1306,8 +1306,8 @@ query customer { "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, - "quote_enabled": false, + "purchase_orders_enabled": true, + "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1316,11 +1316,11 @@ 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", + "telephone": "abc123", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -1334,7 +1334,7 @@ query customer { Return information about the customer's shopping cart. -**Response:** [`Cart!`](types-c-e.md#cart) +**Response:** [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) #### Example @@ -1418,15 +1418,15 @@ query customerCart { "gift_message": GiftMessage, "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, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1438,7 +1438,7 @@ query customerCart { Return a list of downloadable products the customer has purchased. -**Response:** [`CustomerDownloadableProducts`](types-c-e.md#customerdownloadableproducts) +**Response:** [`CustomerDownloadableProducts`](/reference/graphql/saas/types-c-e.md#customerdownloadableproducts) #### Example @@ -1472,7 +1472,7 @@ query customerDownloadableProducts { Provides Customer Group assigned to the Customer or Guest. -**Response:** [`CustomerGroupStorefront!`](types-c-e.md#customergroupstorefront) +**Response:** [`CustomerGroupStorefront!`](/reference/graphql/saas/types-c-e.md#customergroupstorefront) #### Example @@ -1489,7 +1489,7 @@ query customerGroup { ##### Response ```json -{"data": {"customerGroup": {"uid": "4"}}} +{"data": {"customerGroup": {"uid": 4}}} ``` @@ -1498,7 +1498,7 @@ query customerGroup { Return a list of customer payment tokens stored in the vault. -**Response:** [`CustomerPaymentTokens`](types-c-e.md#customerpaymenttokens) +**Response:** [`CustomerPaymentTokens`](/reference/graphql/saas/types-c-e.md#customerpaymenttokens) #### Example @@ -1530,13 +1530,13 @@ query customerPaymentTokens { Customer segments associated with the current customer or guest/visitor. -**Response:** [`[CustomerSegmentStorefront]`](types-c-e.md#customersegmentstorefront) +**Response:** [`[CustomerSegmentStorefront]`](/reference/graphql/saas/types-c-e.md#customersegmentstorefront) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | +| `cartId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of the cart to query. | #### Example @@ -1553,13 +1553,17 @@ query customerSegments($cartId: String!) { ##### Variables ```json -{"cartId": "xyz789"} +{"cartId": "abc123"} ``` ##### Response ```json -{"data": {"customerSegments": [{"uid": 4}]}} +{ + "data": { + "customerSegments": [{"uid": "4"}] + } +} ``` @@ -1568,13 +1572,13 @@ query customerSegments($cartId: String!) { Retrieves the payment configuration for a given location -**Response:** [`PaymentConfigOutput`](types-k-p.md#paymentconfigoutput) +**Response:** [`PaymentConfigOutput`](/reference/graphql/saas/types-k-p.md#paymentconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/saas/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -1630,14 +1634,14 @@ query getPaymentConfig($location: PaymentLocation!) { Retrieves the payment details for the order -**Response:** [`PaymentOrderOutput`](types-k-p.md#paymentorderoutput) +**Response:** [`PaymentOrderOutput`](/reference/graphql/saas/types-k-p.md#paymentorderoutput) #### Arguments | Name | Description | |------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | +| `cartId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | PayPal order ID | #### Example @@ -1666,7 +1670,7 @@ query getPaymentOrder( ```json { - "cartId": "xyz789", + "cartId": "abc123", "id": "abc123" } ``` @@ -1677,7 +1681,7 @@ query getPaymentOrder( { "data": { "getPaymentOrder": { - "id": "xyz789", + "id": "abc123", "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, "status": "xyz789" @@ -1692,13 +1696,13 @@ query getPaymentOrder( Gets the payment SDK urls and values -**Response:** [`GetPaymentSDKOutput`](types-f-i.md#getpaymentsdkoutput) +**Response:** [`GetPaymentSDKOutput`](/reference/graphql/saas/types-f-i.md#getpaymentsdkoutput) #### Arguments | Name | Description | |------|-------------| -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `location` - [`PaymentLocation!`](/reference/graphql/saas/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | #### Example @@ -1736,7 +1740,7 @@ query getPaymentSDK($location: PaymentLocation!) { Retrieves the vault configuration -**Response:** [`VaultConfigOutput`](types-t-z.md#vaultconfigoutput) +**Response:** [`VaultConfigOutput`](/reference/graphql/saas/types-t-z.md#vaultconfigoutput) #### Example @@ -1770,13 +1774,13 @@ query getVaultConfig { Return details about a specific gift card. -**Response:** [`GiftCardAccount`](types-f-i.md#giftcardaccount) +**Response:** [`GiftCardAccount`](/reference/graphql/saas/types-f-i.md#giftcardaccount) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GiftCardAccountInput!`](types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | +| `input` - [`GiftCardAccountInput!`](/reference/graphql/saas/types-f-i.md#giftcardaccountinput) | An input object that specifies the gift card code. | #### Example @@ -1808,7 +1812,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "abc123", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -1820,13 +1824,13 @@ query giftCardAccount($input: GiftCardAccountInput!) { Return the specified gift registry. Some details will not be available to guests. -**Response:** [`GiftRegistry`](types-f-i.md#giftregistry) +**Response:** [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the registry to search for. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the registry to search for. | #### Example @@ -1864,7 +1868,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -1873,7 +1877,7 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], @@ -1898,13 +1902,13 @@ query giftRegistry($giftRegistryUid: ID!) { Search for gift registries by specifying a registrant email address. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/saas/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The registrant's email. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The registrant's email. | #### Example @@ -1936,11 +1940,11 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "xyz789", "gift_registry_uid": 4, "location": "abc123", - "name": "abc123", + "name": "xyz789", "type": "abc123" } ] @@ -1954,13 +1958,13 @@ query giftRegistryEmailSearch($email: String!) { Search for gift registries by specifying a registry URL key. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/saas/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `giftRegistryUid` - [`ID!`](types-f-i.md#id) | The unique ID of the gift registry. | +| `giftRegistryUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the gift registry. | #### Example @@ -1982,7 +1986,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -1993,7 +1997,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "giftRegistryIdSearch": [ { "event_date": "xyz789", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": 4, "location": "xyz789", "name": "xyz789", @@ -2010,15 +2014,15 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { Search for gift registries by specifying the registrant name and registry type ID. -**Response:** [`[GiftRegistrySearchResult]`](types-f-i.md#giftregistrysearchresult) +**Response:** [`[GiftRegistrySearchResult]`](/reference/graphql/saas/types-f-i.md#giftregistrysearchresult) #### Arguments | Name | Description | |------|-------------| -| `firstName` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastName` - [`String!`](types-q-s.md#string) | The last name of the registrant. | -| `giftRegistryTypeUid` - [`ID`](types-f-i.md#id) | The type UID of the registry. | +| `firstName` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the registrant. | +| `lastName` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the registrant. | +| `giftRegistryTypeUid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The type UID of the registry. | #### Example @@ -2049,9 +2053,9 @@ query giftRegistryTypeSearch( ```json { - "firstName": "xyz789", + "firstName": "abc123", "lastName": "xyz789", - "giftRegistryTypeUid": "4" + "giftRegistryTypeUid": 4 } ``` @@ -2063,8 +2067,8 @@ query giftRegistryTypeSearch( "giftRegistryTypeSearch": [ { "event_date": "abc123", - "event_title": "abc123", - "gift_registry_uid": "4", + "event_title": "xyz789", + "gift_registry_uid": 4, "location": "xyz789", "name": "abc123", "type": "abc123" @@ -2080,7 +2084,7 @@ query giftRegistryTypeSearch( Get a list of available gift registry types. -**Response:** [`[GiftRegistryType]`](types-f-i.md#giftregistrytype) +**Response:** [`[GiftRegistryType]`](/reference/graphql/saas/types-f-i.md#giftregistrytype) #### Example @@ -2108,7 +2112,7 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "abc123", + "label": "xyz789", "uid": 4 } ] @@ -2122,13 +2126,13 @@ query giftRegistryTypes { Retrieve guest order details based on number, email and billing last name. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/saas/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`GuestOrderInformationInput!`](types-f-i.md#guestorderinformationinput) | | +| `input` - [`GuestOrderInformationInput!`](/reference/graphql/saas/types-f-i.md#guestorderinformationinput) | | #### Example @@ -2233,7 +2237,7 @@ query guestOrder($input: GuestOrderInformationInput!) { "customer_info": OrderCustomerInfo, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", "invoices": [Invoice], @@ -2241,17 +2245,17 @@ query guestOrder($input: GuestOrderInformationInput!) { "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "xyz789", + "number": "abc123", "order_date": "abc123", "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "xyz789", - "token": "abc123", + "shipping_method": "abc123", + "status": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -2264,13 +2268,13 @@ query guestOrder($input: GuestOrderInformationInput!) { Retrieve guest order details based on token. -**Response:** [`CustomerOrder!`](types-c-e.md#customerorder) +**Response:** [`CustomerOrder!`](/reference/graphql/saas/types-c-e.md#customerorder) #### Arguments | Name | Description | |------|-------------| -| `input` - [`OrderTokenInput!`](types-k-p.md#ordertokeninput) | | +| `input` - [`OrderTokenInput!`](/reference/graphql/saas/types-k-p.md#ordertokeninput) | | #### Example @@ -2384,16 +2388,16 @@ query guestOrderByToken($input: OrderTokenInput!) { "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, "number": "xyz789", - "order_date": "xyz789", - "order_status_change_date": "abc123", + "order_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "abc123", - "token": "abc123", + "shipping_method": "abc123", + "status": "xyz789", + "token": "xyz789", "total": OrderTotal } } @@ -2406,13 +2410,13 @@ query guestOrderByToken($input: OrderTokenInput!) { Check whether the specified email can be used to register a company admin. -**Response:** [`IsCompanyAdminEmailAvailableOutput`](types-f-i.md#iscompanyadminemailavailableoutput) +**Response:** [`IsCompanyAdminEmailAvailableOutput`](/reference/graphql/saas/types-f-i.md#iscompanyadminemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -2429,13 +2433,13 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} ``` @@ -2444,13 +2448,13 @@ query isCompanyAdminEmailAvailable($email: String!) { Check whether the specified email can be used to register a new company. -**Response:** [`IsCompanyEmailAvailableOutput`](types-f-i.md#iscompanyemailavailableoutput) +**Response:** [`IsCompanyEmailAvailableOutput`](/reference/graphql/saas/types-f-i.md#iscompanyemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -2467,7 +2471,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2482,13 +2486,13 @@ query isCompanyEmailAvailable($email: String!) { Check whether the specified role name is valid for the company. -**Response:** [`IsCompanyRoleNameAvailableOutput`](types-f-i.md#iscompanyrolenameavailableoutput) +**Response:** [`IsCompanyRoleNameAvailableOutput`](/reference/graphql/saas/types-f-i.md#iscompanyrolenameavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `name` - [`String!`](types-q-s.md#string) | | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -2505,7 +2509,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "abc123"} +{"name": "xyz789"} ``` ##### Response @@ -2520,13 +2524,13 @@ query isCompanyRoleNameAvailable($name: String!) { Check whether the specified email can be used to register a company user. -**Response:** [`IsCompanyUserEmailAvailableOutput`](types-f-i.md#iscompanyuseremailavailableoutput) +**Response:** [`IsCompanyUserEmailAvailableOutput`](/reference/graphql/saas/types-f-i.md#iscompanyuseremailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -2543,7 +2547,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2558,13 +2562,13 @@ query isCompanyUserEmailAvailable($email: String!) { Check whether the specified email has already been used to create a customer account. -**Response:** [`IsEmailAvailableOutput`](types-f-i.md#isemailavailableoutput) +**Response:** [`IsEmailAvailableOutput`](/reference/graphql/saas/types-f-i.md#isemailavailableoutput) #### Arguments | Name | Description | |------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The email address to check. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address to check. | #### Example @@ -2596,13 +2600,13 @@ query isEmailAvailable($email: String!) { Check if logged-in customer is subscribed to price alert for a product. -**Response:** [`IsProductAlertSubscriptionResult!`](types-f-i.md#isproductalertsubscriptionresult) +**Response:** [`IsProductAlertSubscriptionResult!`](/reference/graphql/saas/types-f-i.md#isproductalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertPriceInput!`](types-k-p.md#productalertpriceinput) | | +| `input` - [`ProductAlertPriceInput!`](/reference/graphql/saas/types-k-p.md#productalertpriceinput) | | #### Example @@ -2629,8 +2633,8 @@ query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "isSubscribedProductAlertPrice": { - "isSubscribed": true, - "message": "xyz789" + "isSubscribed": false, + "message": "abc123" } } } @@ -2642,13 +2646,13 @@ query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) { Check if logged-in customer is subscribed to stock alert for a product. -**Response:** [`IsProductAlertSubscriptionResult!`](types-f-i.md#isproductalertsubscriptionresult) +**Response:** [`IsProductAlertSubscriptionResult!`](/reference/graphql/saas/types-f-i.md#isproductalertsubscriptionresult) #### Arguments | Name | Description | |------|-------------| -| `input` - [`ProductAlertStockInput!`](types-k-p.md#productalertstockinput) | | +| `input` - [`ProductAlertStockInput!`](/reference/graphql/saas/types-k-p.md#productalertstockinput) | | #### Example @@ -2675,7 +2679,7 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { { "data": { "isSubscribedProductAlertStock": { - "isSubscribed": false, + "isSubscribed": true, "message": "xyz789" } } @@ -2688,13 +2692,13 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { Retrieve the specified negotiable quote. -**Response:** [`NegotiableQuote`](types-k-p.md#negotiablequote) +**Response:** [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) #### Arguments | Name | Description | |------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Example @@ -2755,7 +2759,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -2770,24 +2774,24 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "order": CustomerOrder, "prices": CartPrices, - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "SUBMITTED", "template_id": "4", - "template_name": "xyz789", + "template_name": "abc123", "total_quantity": 123.45, "uid": 4, "updated_at": "abc123" @@ -2802,13 +2806,13 @@ query negotiableQuote($uid: ID!) { Retrieve the specified negotiable quote template. -**Response:** [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) +**Response:** [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) #### Arguments | Name | Description | |------|-------------| -| `templateId` - [`ID!`](types-f-i.md#id) | | +| `templateId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Example @@ -2875,7 +2879,7 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], @@ -2883,8 +2887,8 @@ query negotiableQuoteTemplate($templateId: ID!) { "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": [ @@ -2895,10 +2899,10 @@ query negotiableQuoteTemplate($templateId: ID!) { NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 987.65, - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } } } @@ -2910,16 +2914,16 @@ query negotiableQuoteTemplate($templateId: ID!) { Return a list of negotiable quote templates that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuoteTemplatesOutput`](types-k-p.md#negotiablequotetemplatesoutput) +**Response:** [`NegotiableQuoteTemplatesOutput`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplatesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteTemplateFilterInput`](types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteTemplateSortInput`](types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteTemplateFilterInput`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplatefilterinput) | The filter to use to determine which negotiable quote templates to return. | +| `pageSize` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteTemplateSortInput`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplatesortinput) | The field to use for sorting results. | #### Example @@ -2972,7 +2976,7 @@ query negotiableQuoteTemplates( "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -2984,16 +2988,16 @@ query negotiableQuoteTemplates( Return a list of negotiable quotes that can be viewed by the logged-in customer. -**Response:** [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) +**Response:** [`NegotiableQuotesOutput`](/reference/graphql/saas/types-k-p.md#negotiablequotesoutput) #### Arguments | Name | Description | |------|-------------| -| `filter` - [`NegotiableQuoteFilterInput`](types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | -| `sort` - [`NegotiableQuoteSortInput`](types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | +| `filter` - [`NegotiableQuoteFilterInput`](/reference/graphql/saas/types-k-p.md#negotiablequotefilterinput) | The filter to use to determine which negotiable quotes to return. | +| `pageSize` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of results to return at once. The default value is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The page of results to return. The default value is 1. Default: `1` | +| `sort` - [`NegotiableQuoteSortInput`](/reference/graphql/saas/types-k-p.md#negotiablequotesortinput) | The field to use for sorting results. | #### Example @@ -3058,18 +3062,18 @@ query negotiableQuotes( The pickup locations query searches for locations that match the search request requirements. -**Response:** [`PickupLocations`](types-k-p.md#pickuplocations) +**Response:** [`PickupLocations`](/reference/graphql/saas/types-k-p.md#pickuplocations) #### Arguments | Name | Description | |------|-------------| -| `area` - [`AreaInput`](types-a-b.md#areainput) | Perform search by location using radius and search term. | -| `filters` - [`PickupLocationFilterInput`](types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | -| `sort` - [`PickupLocationSortInput`](types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | -| `pageSize` - [`Int`](types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | -| `productsInfo` - [`[ProductInfoInput]`](types-k-p.md#productinfoinput) | Information about products which should be delivered. | +| `area` - [`AreaInput`](/reference/graphql/saas/types-a-b.md#areainput) | Perform search by location using radius and search term. | +| `filters` - [`PickupLocationFilterInput`](/reference/graphql/saas/types-k-p.md#pickuplocationfilterinput) | Apply filters by attributes. | +| `sort` - [`PickupLocationSortInput`](/reference/graphql/saas/types-k-p.md#pickuplocationsortinput) | Specifies which attribute to sort on, and whether to return the results in ascending or descending order. | +| `pageSize` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of pickup locations to return at once. The attribute is optional. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. Default: `1` | +| `productsInfo` - [`[ProductInfoInput]`](/reference/graphql/saas/types-k-p.md#productinfoinput) | Information about products which should be delivered. | #### Example @@ -3136,18 +3140,18 @@ query pickupLocations( Search products using Live Search -**Response:** [`ProductSearchResponse!`](types-k-p.md#productsearchresponse) +**Response:** [`ProductSearchResponse!`](/reference/graphql/saas/types-k-p.md#productsearchresponse) #### Arguments | Name | Description | |------|-------------| -| `context` - [`QueryContextInput`](types-q-s.md#querycontextinput) | The query context | -| `current_page` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1 Default: `1` | -| `filter` - [`[SearchClauseInput!]`](types-q-s.md#searchclauseinput) | Identifies product attributes and conditions to filter on | -| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of results to return at once Default: `20` | -| `phrase` - [`String!`](types-q-s.md#string) | Phrase to search for in product catalog | -| `sort` - [`[ProductSearchSortInput!]`](types-k-p.md#productsearchsortinput) | Attributes and direction to sort on | +| `context` - [`QueryContextInput`](/reference/graphql/saas/types-q-s.md#querycontextinput) | The query context | +| `current_page` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Specifies which page of results to return. The default value is 1 Default: `1` | +| `filter` - [`[SearchClauseInput!]`](/reference/graphql/saas/types-q-s.md#searchclauseinput) | Identifies product attributes and conditions to filter on | +| `page_size` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of results to return at once Default: `20` | +| `phrase` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Phrase to search for in product catalog | +| `sort` - [`[ProductSearchSortInput!]`](/reference/graphql/saas/types-k-p.md#productsearchsortinput) | Attributes and direction to sort on | #### Example @@ -3197,7 +3201,7 @@ query productSearch( "current_page": 1, "filter": [SearchClauseInput], "page_size": 20, - "phrase": "xyz789", + "phrase": "abc123", "sort": [ProductSearchSortInput] } ``` @@ -3213,7 +3217,7 @@ query productSearch( "page_info": SearchResultPageInfo, "related_terms": ["abc123"], "suggestions": ["abc123"], - "total_count": 123, + "total_count": 987, "warnings": [ProductSearchWarning] } } @@ -3226,13 +3230,13 @@ query productSearch( Search for products that match the specified SKU values. In Adobe Commerce as a Cloud Service, this query replaces the `products` query defined in the Commerce Foundation. -**Response:** [`[ProductView]`](types-k-p.md#productview) +**Response:** [`[ProductView]`](/reference/graphql/saas/types-k-p.md#productview) #### Arguments | Name | Description | |------|-------------| -| `skus` - [`[String]`](types-q-s.md#string) | List of SKUs to search for. For example, `123`, `456` or `789`. | +| `skus` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | List of SKUs to search for. For example, `123`, `456` or `789`. | #### Example @@ -3280,7 +3284,7 @@ query products($skus: [String]) { ##### Variables ```json -{"skus": ["xyz789"]} +{"skus": ["abc123"]} ``` ##### Response @@ -3290,24 +3294,24 @@ query products($skus: [String]) { "data": { "products": [ { - "addToCartAllowed": true, + "addToCartAllowed": false, "inStock": true, "lowStock": false, "attributes": [ProductViewAttribute], - "description": "xyz789", + "description": "abc123", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "abc123", - "metaKeyword": "xyz789", - "metaTitle": "xyz789", + "metaKeyword": "abc123", + "metaTitle": "abc123", "name": "abc123", - "shortDescription": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "abc123", - "externalId": "xyz789", - "url": "xyz789", + "sku": "xyz789", + "externalId": "abc123", + "url": "abc123", "urlKey": "xyz789", "links": [ProductViewLink], "queryType": "xyz789", @@ -3322,13 +3326,13 @@ query products($skus: [String]) { ### recaptchaFormConfig -**Response:** [`ReCaptchaConfigOutput`](types-q-s.md#recaptchaconfigoutput) +**Response:** [`ReCaptchaConfigOutput`](/reference/graphql/saas/types-q-s.md#recaptchaconfigoutput) #### Arguments | Name | Description | |------|-------------| -| `formType` - [`ReCaptchaFormEnum!`](types-q-s.md#recaptchaformenum) | | +| `formType` - [`ReCaptchaFormEnum!`](/reference/graphql/saas/types-q-s.md#recaptchaformenum) | | #### Example @@ -3358,7 +3362,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } } } @@ -3370,13 +3374,13 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { Returns reCAPTCHA configuration details for multiple form types in a single request. -**Response:** [`[ReCaptchaFormConfigItem]`](types-q-s.md#recaptchaformconfigitem) +**Response:** [`[ReCaptchaFormConfigItem]`](/reference/graphql/saas/types-q-s.md#recaptchaformconfigitem) #### Arguments | Name | Description | |------|-------------| -| `formTypes` - [`[ReCaptchaFormEnum!]!`](types-q-s.md#recaptchaformenum) | | +| `formTypes` - [`[ReCaptchaFormEnum!]!`](/reference/graphql/saas/types-q-s.md#recaptchaformenum) | | #### Example @@ -3422,7 +3426,7 @@ query recaptchaFormConfigs($formTypes: [ReCaptchaFormEnum!]!) { Returns details about Google reCAPTCHA V3-Invisible configuration. -**Response:** [`ReCaptchaConfigurationV3`](types-q-s.md#recaptchaconfigurationv3) +**Response:** [`ReCaptchaConfigurationV3`](/reference/graphql/saas/types-q-s.md#recaptchaconfigurationv3) #### Example @@ -3449,14 +3453,14 @@ query recaptchaV3Config { { "data": { "recaptchaV3Config": { - "badge_position": "xyz789", - "failure_message": "abc123", + "badge_position": "abc123", + "failure_message": "xyz789", "forms": ["PLACE_ORDER"], "is_enabled": true, - "language_code": "xyz789", + "language_code": "abc123", "minimum_score": 123.45, - "theme": "xyz789", - "website_key": "abc123" + "theme": "abc123", + "website_key": "xyz789" } } } @@ -3468,20 +3472,20 @@ query recaptchaV3Config { Get Recommendations -**Response:** [`Recommendations`](types-q-s.md#recommendations) +**Response:** [`Recommendations`](/reference/graphql/saas/types-q-s.md#recommendations) #### Arguments | Name | Description | |------|-------------| -| `cartSkus` - [`[String]`](types-q-s.md#string) | SKUs of products in the cart | -| `category` - [`String`](types-q-s.md#string) | Category currently being viewed | -| `currentSku` - [`String`](types-q-s.md#string) | SKU of the product currently being viewed on PDP | -| `currentProduct` - [`CurrentProductInput`](types-c-e.md#currentproductinput) | Current product context from PDP (SKU, price, category, etc.) | -| `pageType` - [`PageType`](types-k-p.md#pagetype) | Type of page on which recommendations are requested | -| `userPurchaseHistory` - [`[PurchaseHistory]`](types-k-p.md#purchasehistory) | User purchase history with timestamp | -| `userViewHistory` - [`[ViewHistory]`](types-t-z.md#viewhistory) | User view history with timestamp | -| `config` - [`UnitConfigInput`](types-t-z.md#unitconfiginput) | Optional unit configuration | +| `cartSkus` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | SKUs of products in the cart | +| `category` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Category currently being viewed | +| `currentSku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | SKU of the product currently being viewed on PDP | +| `currentProduct` - [`CurrentProductInput`](/reference/graphql/saas/types-c-e.md#currentproductinput) | Current product context from PDP (SKU, price, category, etc.) | +| `pageType` - [`PageType`](/reference/graphql/saas/types-k-p.md#pagetype) | Type of page on which recommendations are requested | +| `userPurchaseHistory` - [`[PurchaseHistory]`](/reference/graphql/saas/types-k-p.md#purchasehistory) | User purchase history with timestamp | +| `userViewHistory` - [`[ViewHistory]`](/reference/graphql/saas/types-t-z.md#viewhistory) | User view history with timestamp | +| `config` - [`UnitConfigInput`](/reference/graphql/saas/types-t-z.md#unitconfiginput) | Optional unit configuration | #### Example @@ -3521,8 +3525,8 @@ query recommendations( ```json { "cartSkus": ["abc123"], - "category": "xyz789", - "currentSku": "xyz789", + "category": "abc123", + "currentSku": "abc123", "currentProduct": CurrentProductInput, "pageType": "CMS", "userPurchaseHistory": [PurchaseHistory], @@ -3538,7 +3542,7 @@ query recommendations( "data": { "recommendations": { "results": [RecommendationUnit], - "totalResults": 123 + "totalResults": 987 } } } @@ -3550,14 +3554,14 @@ query recommendations( Narrow down the results of a `products` query that was run against a complex product. Specify option IDs and SKUs to refine the product. -**Response:** [`ProductView`](types-k-p.md#productview) +**Response:** [`ProductView`](/reference/graphql/saas/types-k-p.md#productview) #### Arguments | Name | Description | |------|-------------| -| `optionIds` - [`[String!]!`](types-q-s.md#string) | List of option IDs to refine the product by. For example, `123`, `456` or `789`. | -| `sku` - [`String!`](types-q-s.md#string) | SKU of the product to refine. For example, `RF903`, `DG90-54` or `789-001`. | +| `optionIds` - [`[String!]!`](/reference/graphql/saas/types-q-s.md#string) | List of option IDs to refine the product by. For example, `123`, `456` or `789`. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | SKU of the product to refine. For example, `RF903`, `DG90-54` or `789-001`. | #### Example @@ -3612,7 +3616,7 @@ query refineProduct( ```json { - "optionIds": ["abc123"], + "optionIds": ["xyz789"], "sku": "abc123" } ``` @@ -3624,27 +3628,27 @@ query refineProduct( "data": { "refineProduct": { "addToCartAllowed": false, - "inStock": 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": "abc123", + "metaDescription": "xyz789", "metaKeyword": "abc123", "metaTitle": "abc123", "name": "abc123", - "shortDescription": "xyz789", + "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], - "sku": "xyz789", - "externalId": "xyz789", + "sku": "abc123", + "externalId": "abc123", "url": "abc123", "urlKey": "abc123", "links": [ProductViewLink], "queryType": "xyz789", - "visibility": "abc123" + "visibility": "xyz789" } } } @@ -3656,13 +3660,13 @@ query refineProduct( View a shared requisition list when the receiver is logged in and belongs to the same company as the sender. -**Response:** [`SharedRequisitionListOutput`](types-q-s.md#sharedrequisitionlistoutput) +**Response:** [`SharedRequisitionListOutput`](/reference/graphql/saas/types-q-s.md#sharedrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `token` - [`String!`](types-q-s.md#string) | The share token which is extracted from the requisition list share link and acts as an identifier for the requisition list. | +| `token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The share token which is extracted from the requisition list share link and acts as an identifier for the requisition list. | #### Example @@ -3682,7 +3686,7 @@ query sharedRequisitionList($token: String!) { ##### Variables ```json -{"token": "xyz789"} +{"token": "abc123"} ``` ##### Response @@ -3692,7 +3696,7 @@ query sharedRequisitionList($token: String!) { "data": { "sharedRequisitionList": { "requisition_list": RequisitionList, - "sender_name": "abc123" + "sender_name": "xyz789" } } } @@ -3704,7 +3708,7 @@ query sharedRequisitionList($token: String!) { Return details about the store's configuration. -**Response:** [`StoreConfig`](types-q-s.md#storeconfig) +**Response:** [`StoreConfig`](/reference/graphql/saas/types-q-s.md#storeconfig) #### Example @@ -3873,148 +3877,148 @@ query storeConfig { { "data": { "storeConfig": { - "allow_company_registration": true, + "allow_company_registration": false, "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_items": "xyz789", - "allow_order": "xyz789", + "allow_items": "abc123", + "allow_order": "abc123", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, - "base_currency_code": "abc123", - "base_link_url": "abc123", + "autocomplete_on_storefront": true, + "base_currency_code": "xyz789", + "base_link_url": "xyz789", "base_media_url": "abc123", - "base_static_url": "xyz789", + "base_static_url": "abc123", "base_url": "abc123", "cart_expires_in_days": 123, - "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", + "cart_gift_wrapping": "xyz789", + "cart_merge_preference": "abc123", "cart_printed_card": "abc123", "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "abc123", + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "abc123", "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_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_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "abc123", "check_money_order_sort_order": 987, - "check_money_order_title": "xyz789", + "check_money_order_title": "abc123", "company_credit_enabled": true, - "company_enabled": false, + "company_enabled": true, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", "contact_enabled": false, "countries_with_required_region": "abc123", - "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, - "default_country": "abc123", + "create_account_confirmation": true, + "customer_access_token_lifetime": 987.65, + "default_country": "xyz789", "default_display_currency_code": "xyz789", - "display_product_prices_in_catalog": 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, - "graphql_share_customer_group": false, - "grid_per_page": 987, + "fixed_product_taxes_display_prices_in_product_lists": 987, + "fixed_product_taxes_display_prices_in_sales_modules": 123, + "fixed_product_taxes_display_prices_on_product_view_page": 987, + "fixed_product_taxes_enable": false, + "fixed_product_taxes_include_fpt_in_subtotal": false, + "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": true, - "is_default_store_group": false, + "is_checkout_agreements_enabled": true, + "is_default_store": false, + "is_default_store_group": true, "is_guest_checkout_enabled": false, "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": false, + "is_one_page_checkout_enabled": true, "is_requisition_list_active": "xyz789", "list_mode": "xyz789", - "list_per_page": 987, + "list_per_page": 123, "list_per_page_values": "xyz789", - "locale": "abc123", + "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_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_order": "xyz789", - "magento_reward_points_register": "abc123", - "magento_reward_points_review": "abc123", + "magento_reward_points_order": "abc123", + "magento_reward_points_register": "xyz789", + "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "xyz789", - "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, - "minimum_password_length": "abc123", - "newsletter_enabled": false, - "optional_zip_countries": "xyz789", - "order_cancellation_enabled": false, + "minicart_display": true, + "minicart_max_items": 987, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, + "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_price": 123, "orders_invoices_credit_memos_display_shipping_amount": 123, - "orders_invoices_credit_memos_display_subtotal": 987, - "orders_invoices_credit_memos_display_zero_tax": false, + "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_zero_tax": true, "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_url_suffix": "abc123", - "quickorder_active": true, + "quickorder_active": false, "quote_minimum_amount": 987.65, "quote_minimum_amount_message": "abc123", "required_character_classes_number": "abc123", "requisition_list_share_link_validity_days": 987, - "requisition_list_share_max_recipients": 123, + "requisition_list_share_max_recipients": 987, "requisition_list_share_storefront_path": "abc123", - "requisition_list_sharing_enabled": false, - "returns_enabled": "abc123", + "requisition_list_sharing_enabled": true, + "returns_enabled": "xyz789", "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "xyz789", - "sales_printed_card": "abc123", + "sales_printed_card": "xyz789", "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_static_url": "abc123", + "secure_base_url": "abc123", "share_active_segments": false, - "share_applied_cart_rule": true, + "share_applied_cart_rule": false, "shopping_assistance_checkbox_title": "xyz789", - "shopping_assistance_checkbox_tooltip": "xyz789", - "shopping_assistance_enabled": true, + "shopping_assistance_checkbox_tooltip": "abc123", + "shopping_assistance_enabled": false, "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": 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": true, - "store_code": 4, + "store_code": "4", "store_group_code": 4, - "store_group_name": "abc123", + "store_group_name": "xyz789", "store_name": "abc123", - "store_sort_order": 987, - "timezone": "abc123", - "title_separator": "xyz789", + "store_sort_order": 123, + "timezone": "xyz789", + "title_separator": "abc123", "use_store_in_url": true, - "website_code": 4, - "website_name": "abc123", - "weight_unit": "abc123", - "zero_subtotal_enable_for_specific_countries": true, + "website_code": "4", + "website_name": "xyz789", + "weight_unit": "xyz789", + "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", + "zero_subtotal_new_order_status": "xyz789", "zero_subtotal_payment_action": "abc123", "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 987, @@ -4028,16 +4032,16 @@ query storeConfig { ### variants -**Response:** [`ProductViewVariantResults`](types-k-p.md#productviewvariantresults) +**Response:** [`ProductViewVariantResults`](/reference/graphql/saas/types-k-p.md#productviewvariantresults) #### Arguments | Name | Description | |------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | SKU of the product to get variants for. For example, `UR123`, `MZ456` or `KS789`. | -| `optionIds` - [`[String!]`](types-q-s.md#string) | List of option IDs to get variants for. For example, `123`, `456` or `789`. | -| `pageSize` - [`Int`](types-f-i.md#int) | Page size for pagination. For example, `10` for a page size of 10 or `20` for a page size of 20. | -| `cursor` - [`String`](types-q-s.md#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | SKU of the product to get variants for. For example, `UR123`, `MZ456` or `KS789`. | +| `optionIds` - [`[String!]`](/reference/graphql/saas/types-q-s.md#string) | List of option IDs to get variants for. For example, `123`, `456` or `789`. | +| `pageSize` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Page size for pagination. For example, `10` for a page size of 10 or `20` for a page size of 20. | +| `cursor` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | #### Example @@ -4069,7 +4073,7 @@ query variants( ```json { "sku": "xyz789", - "optionIds": ["abc123"], + "optionIds": ["xyz789"], "pageSize": 987, "cursor": "xyz789" } 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 index 26e3de536..6103fe860 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md @@ -8,7 +8,7 @@ Specifies the quote template id to accept quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -26,7 +26,7 @@ Contains details about the cart after adding custom attributes to it items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The custom attributes to cart item have been added. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The custom attributes to cart item have been added. | #### Example @@ -42,14 +42,14 @@ Contains details about the cart after adding custom attributes to it items. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](/reference/graphql/saas/types-c-e.md#downloadableproductcartiteminput) | An array of downloadable products to add. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [DownloadableProductCartItemInput] } ``` @@ -64,7 +64,7 @@ Contains details about the cart after adding downloadable products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after adding products. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after adding products. | #### Example @@ -82,10 +82,10 @@ Defines a new registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/saas/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address of the registrant. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the registrant. | #### Example @@ -96,7 +96,7 @@ Defines a new registrant. ], "email": "xyz789", "firstname": "abc123", - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -110,7 +110,7 @@ Contains the results of a request to add registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after adding registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The gift registry after adding registrants. | #### Example @@ -128,8 +128,8 @@ Contains details about the cart after adding products to it. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after products have been added. | -| `user_errors` - [`[Error]!`](types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](/reference/graphql/saas/types-c-e.md#error) | Contains errors encountered while adding an item to the cart. | #### Example @@ -150,13 +150,16 @@ Contains products to add to an existing compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": ["4"], "uid": 4} +{ + "products": ["4"], + "uid": "4" +} ``` @@ -169,8 +172,8 @@ Contains details about the cart after adding products to it. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](types-c-e.md#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]`](types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `cart` - [`Cart`](/reference/graphql/saas/types-c-e.md#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]`](/reference/graphql/saas/types-c-e.md#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | #### Example @@ -191,7 +194,7 @@ Output of the request to add products to a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after adding products. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The requisition list after adding products. | #### Example @@ -209,8 +212,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/saas/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -231,15 +234,15 @@ Contains the comment to be added to a purchase order. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `comment` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json { "comment": "xyz789", - "purchase_order_uid": "4" + "purchase_order_uid": 4 } ``` @@ -253,7 +256,7 @@ Contains the successfully added comment. | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](types-k-p.md#purchaseordercomment) | The purchase order comment. | +| `comment` - [`PurchaseOrderComment!`](/reference/graphql/saas/types-k-p.md#purchaseordercomment) | The purchase order comment. | #### Example @@ -271,8 +274,8 @@ Defines the purchase order and cart to act on. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | Purchase order unique ID. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | Purchase order unique ID. | | `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | #### Example @@ -295,7 +298,7 @@ Contains details about why an attempt to add items to the requistion list failed | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | A description of the error. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A description of the error. | | `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | #### Example @@ -337,7 +340,7 @@ Output of the request to add items in a requisition list to the cart. | 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`](types-c-e.md#cart) | The cart after adding requisition list items. | +| `cart` - [`Cart`](/reference/graphql/saas/types-c-e.md#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 @@ -362,14 +365,14 @@ Defines a return comment. | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String!`](types-q-s.md#string) | The text added to the return request. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `comment_text` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The text added to the return request. | +| `return_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example ```json { - "comment_text": "xyz789", + "comment_text": "abc123", "return_uid": "4" } ``` @@ -384,7 +387,7 @@ Contains details about the return request. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | The modified return. | +| `return` - [`Return`](/reference/graphql/saas/types-q-s.md#return) | The modified return. | #### Example @@ -402,16 +405,16 @@ Defines tracking information to be added to the return. | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](types-q-s.md#string) | The shipping tracking number for this return request. | +| `carrier_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The shipping tracking number for this return request. | #### Example ```json { "carrier_uid": 4, - "return_uid": "4", + "return_uid": 4, "tracking_number": "xyz789" } ``` @@ -426,8 +429,8 @@ Contains the response after adding tracking information. | Field Name | Description | |------------|-------------| -| `return` - [`Return`](types-q-s.md#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](types-q-s.md#returnshippingtracking) | Details about shipping for a return. | +| `return` - [`Return`](/reference/graphql/saas/types-q-s.md#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](/reference/graphql/saas/types-q-s.md#returnshippingtracking) | Details about shipping for a return. | #### Example @@ -448,9 +451,9 @@ Contains the resultant wish list and any error information. | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](types-t-z.md#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](/reference/graphql/saas/types-t-z.md#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!`](types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | +| `wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | Contains the wish list with all items that were successfully added. | #### Example @@ -474,9 +477,9 @@ A single admin assistance action performed on behalf of the customer. | Field Name | Description | |------------|-------------| -| `action` - [`String!`](types-q-s.md#string) | Action identifier, e.g. add_to_cart, place_order. | -| `date` - [`String!`](types-q-s.md#string) | When the action occurred. | -| `details` - [`String`](types-q-s.md#string) | Action related details, e.g. product SKUs, order id. | +| `action` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Action identifier, e.g. add_to_cart, place_order. | +| `date` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | When the action occurred. | +| `details` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Action related details, e.g. product SKUs, order id. | #### Example @@ -499,8 +502,8 @@ Paginated admin assistance actions for the customer. | Field Name | Description | |------------|-------------| | `items` - [`[AdminAssistanceAction]!`](#adminassistanceaction) | Admin assistance actions for the current page. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The total count of admin assistance actions for the customer. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total count of admin assistance actions for the customer. | #### Example @@ -522,9 +525,9 @@ A bucket that contains information for each filterable option | Field Name | Description | |------------|-------------| -| `attribute` - [`String!`](types-q-s.md#string) | The attribute code of the filter item | +| `attribute` - [`String!`](/reference/graphql/saas/types-q-s.md#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!`](types-q-s.md#string) | The filter name displayed in layered navigation | +| `title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The filter name displayed in layered navigation | | `type` - [`AggregationType`](#aggregationtype) | Identifies the data type of the aggregation | #### Example @@ -533,7 +536,7 @@ A bucket that contains information for each filterable option { "attribute": "abc123", "buckets": [Bucket], - "title": "abc123", + "title": "xyz789", "type": "INTELLIGENT" } ``` @@ -567,25 +570,25 @@ Identifies the data type of the aggregation | Field Name | Description | |------------|-------------| | `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `payment_intent` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/saas/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { "button_styles": ButtonStyles, - "code": "xyz789", + "code": "abc123", "is_visible": false, - "payment_intent": "xyz789", + "payment_intent": "abc123", "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "title": "xyz789" } ``` @@ -600,9 +603,9 @@ Apple Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | PayPal order ID | #### Example @@ -624,7 +627,7 @@ Contains the applied coupon code. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The coupon code the shopper applied to the card. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The coupon code the shopper applied to the card. | #### Example @@ -642,10 +645,10 @@ Contains an applied gift card with applied and remaining balance. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The amount applied to the current cart. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `current_balance` - [`Money`](types-k-p.md#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `applied_balance` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The amount applied to the current cart. | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The gift card account code. | +| `current_balance` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -654,7 +657,7 @@ Contains an applied gift card with applied and remaining balance. "applied_balance": Money, "code": "abc123", "current_balance": Money, - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -669,8 +672,8 @@ The rule that was applied to this product | Field Name | Description | |------------|-------------| | `action_type` - [`AppliedQueryRuleActionType`](#appliedqueryruleactiontype) | An enum that defines the type of rule that was applied | -| `rule_id` - [`String`](types-q-s.md#string) | The ID assigned to the rule | -| `rule_name` - [`String`](types-q-s.md#string) | The name of the applied rule | +| `rule_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ID assigned to the rule | +| `rule_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the applied rule | #### Example @@ -712,8 +715,8 @@ Contains the applied and current balances. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](types-k-p.md#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](types-k-p.md#money) | The current balance remaining on store credit. | +| `applied_balance` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](/reference/graphql/saas/types-k-p.md#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 @@ -736,14 +739,14 @@ Specifies the coupon code to apply to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](types-q-s.md#string) | A valid coupon code. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A valid coupon code. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "coupon_code": "xyz789" } ``` @@ -758,7 +761,7 @@ Contains details about the cart after applying a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after applying a coupon. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after applying a coupon. | #### Example @@ -795,15 +798,15 @@ Apply coupons to the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](types-q-s.md#string) | An array of valid coupon codes. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](/reference/graphql/saas/types-q-s.md#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", + "cart_id": "xyz789", "coupon_codes": ["abc123"], "type": "APPEND" } @@ -819,15 +822,15 @@ Defines the input required to run the `applyGiftCardToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](types-q-s.md#string) | The gift card code to be applied to the cart. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The gift card code to be applied to the cart. | #### Example ```json { - "cart_id": "xyz789", - "gift_card_code": "abc123" + "cart_id": "abc123", + "gift_card_code": "xyz789" } ``` @@ -841,7 +844,7 @@ Defines the possible output for the `applyGiftCardToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Describes the contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | Describes the contents of the specified shopping cart. | #### Example @@ -859,8 +862,8 @@ Contains applied gift cards with gift card code and amount. | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](types-k-p.md#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](types-q-s.md#string) | The gift card account code. | +| `applied_balance` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The gift card account code. | #### Example @@ -881,7 +884,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are applied. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The customer cart after reward points are applied. | #### Example @@ -899,7 +902,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID that identifies the customer's cart. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID that identifies the customer's cart. | #### Example @@ -917,7 +920,7 @@ Defines the possible output for the `applyStoreCreditToCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -935,8 +938,8 @@ AreaInput defines the parameters which will be used for filter by specified loca | Input Field | Description | |-------------|-------------| -| `radius` - [`Int!`](types-f-i.md#int) | The radius for the search in KM. | -| `search_term` - [`String!`](types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| `radius` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The radius for the search in KM. | +| `search_term` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | #### Example @@ -954,11 +957,11 @@ Contains information about an asset image. | Field Name | Description | |------------|-------------| -| `asset_image` - [`ProductMediaGalleryEntriesAssetImage`](types-k-p.md#productmediagalleryentriesassetimage) | Contains a `ProductMediaGalleryEntriesAssetImage` object. | +| `asset_image` - [`ProductMediaGalleryEntriesAssetImage`](/reference/graphql/saas/types-k-p.md#productmediagalleryentriesassetimage) | Contains a `ProductMediaGalleryEntriesAssetImage` object. | | `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL of the product image or video. | #### Example @@ -982,11 +985,11 @@ Contains information about an asset video. | Field Name | Description | |------------|-------------| -| `asset_video` - [`ProductMediaGalleryEntriesAssetVideo`](types-k-p.md#productmediagalleryentriesassetvideo) | Contains a `ProductMediaGalleryEntriesAssetVideo` object. | +| `asset_video` - [`ProductMediaGalleryEntriesAssetVideo`](/reference/graphql/saas/types-k-p.md#productmediagalleryentriesassetvideo) | Contains a `ProductMediaGalleryEntriesAssetVideo` object. | | `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL of the product image or video. | #### Example @@ -995,7 +998,7 @@ Contains information about an asset video. "asset_video": ProductMediaGalleryEntriesAssetVideo, "disabled": false, "label": "abc123", - "position": 987, + "position": 123, "url": "xyz789" } ``` @@ -1010,15 +1013,15 @@ Defines the input schema for assigning a child company to a parent company. | Input Field | Description | |-------------|-------------| -| `child_company_id` - [`ID!`](types-f-i.md#id) | The unique ID of the child company. | -| `parent_company_id` - [`ID!`](types-f-i.md#id) | The unique ID of the parent company. | +| `child_company_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the child company. | +| `parent_company_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the parent company. | #### Example ```json { - "child_company_id": 4, - "parent_company_id": "4" + "child_company_id": "4", + "parent_company_id": 4 } ``` @@ -1032,7 +1035,7 @@ Contains the response to the request to assign a child company. | Field Name | Description | |------------|-------------| -| `company_hierarchy` - [`CompanyHierarchy!`](types-c-e.md#companyhierarchy) | The updated company hierarchy for the parent company. | +| `company_hierarchy` - [`CompanyHierarchy!`](/reference/graphql/saas/types-c-e.md#companyhierarchy) | The updated company hierarchy for the parent company. | #### Example @@ -1050,7 +1053,7 @@ Contains the results of the request to assign a compare list. | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](types-c-e.md#comparelist) | The contents of the customer's compare list. | +| `compare_list` - [`CompareList`](/reference/graphql/saas/types-c-e.md#comparelist) | The contents of the customer's compare list. | | `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | #### Example @@ -1089,19 +1092,19 @@ List of all entity types. Populated by the modules introducing EAV entities. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | -| `url` - [`String!`](types-q-s.md#string) | File URL to download the file. | -| `value` - [`String!`](types-q-s.md#string) | File code. For file download use `url` field. | +| `attribute_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The attribute code. | +| `url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | File URL to download the file. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | File code. For file download use `url` field. | #### Example ```json { - "attribute_type": "xyz789", - "code": 4, - "url": "xyz789", - "value": "xyz789" + "attribute_type": "abc123", + "code": "4", + "url": "abc123", + "value": "abc123" } ``` @@ -1132,18 +1135,18 @@ An input object that specifies the filters used for attributes. ```json { - "is_comparable": true, + "is_comparable": false, "is_filterable": false, - "is_filterable_in_search": true, - "is_html_allowed_on_front": false, + "is_filterable_in_search": false, + "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": true, - "is_visible_in_advanced_search": true, + "is_used_for_customer_segment": false, + "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": true + "used_in_product_listing": false } ``` @@ -1188,16 +1191,16 @@ EAV attribute frontend input types. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | -| `url` - [`String!`](types-q-s.md#string) | Image URL to download the image. | -| `value` - [`String!`](types-q-s.md#string) | Image code. For image download use `url` field. | +| `attribute_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The attribute code. | +| `url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Image URL to download the image. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Image code. For image download use `url` field. | #### Example ```json { - "attribute_type": "abc123", + "attribute_type": "xyz789", "code": 4, "url": "abc123", "value": "xyz789" @@ -1214,8 +1217,8 @@ Defines the attribute characteristics to search for the `attribute_code` and `en | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](types-q-s.md#string) | The type of entity that defines the attribute. | +| `attribute_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of entity that defines the attribute. | #### Example @@ -1236,7 +1239,7 @@ Specifies selected option for a select or multiselect attribute value. | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute option value. | #### Example @@ -1254,15 +1257,15 @@ Base EAV implementation of CustomAttributeMetadataInterface. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Default attribute value. | | `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_class` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/saas/types-c-e.md#customattributeoptioninterface) | Attribute options. | #### Example @@ -1271,11 +1274,11 @@ Base EAV implementation of CustomAttributeMetadataInterface. "code": 4, "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", - "is_required": true, + "is_required": false, "is_unique": true, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -1290,14 +1293,14 @@ Attribute metadata retrieval error. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | Attribute metadata retrieval error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Attribute metadata retrieval error message. | | `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "type": "ENTITY_NOT_FOUND" } ``` @@ -1333,8 +1336,8 @@ Contains the output of the `attributeMetadata` query | Field Name | Description | |------------|-------------| -| `filterableInSearch` - [`[FilterableInSearchAttribute!]`](types-f-i.md#filterableinsearchattribute) | An array of product attributes that can be used for filtering in a `productSearch` query | -| `sortable` - [`[SortableAttribute!]`](types-q-s.md#sortableattribute) | An array of product attributes that can be used for sorting in a `productSearch` query | +| `filterableInSearch` - [`[FilterableInSearchAttribute!]`](/reference/graphql/saas/types-f-i.md#filterableinsearchattribute) | An array of product attributes that can be used for filtering in a `productSearch` query | +| `sortable` - [`[SortableAttribute!]`](/reference/graphql/saas/types-q-s.md#sortableattribute) | An array of product attributes that can be used for sorting in a `productSearch` query | #### Example @@ -1356,16 +1359,16 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| | `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute option value. | #### Example ```json { "is_default": true, - "label": "abc123", - "value": "xyz789" + "label": "xyz789", + "value": "abc123" } ``` @@ -1377,15 +1380,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute selected option value. | #### Example ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -1397,8 +1400,8 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The attribute selected option label. | -| `value` - [`String!`](types-q-s.md#string) | The attribute selected option value. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute selected option label. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute selected option value. | #### Possible Types @@ -1423,15 +1426,15 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `attribute_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The attribute code. | | `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | #### Example ```json { - "attribute_type": "abc123", + "attribute_type": "xyz789", "code": "4", "selected_options": [AttributeSelectedOptionInterface] } @@ -1445,17 +1448,17 @@ Base EAV implementation of CustomAttributeOptionInterface. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The attribute value. | +| `attribute_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The attribute code. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute value. | #### Example ```json { - "attribute_type": "xyz789", - "code": "4", - "value": "xyz789" + "attribute_type": "abc123", + "code": 4, + "value": "abc123" } ``` @@ -1469,17 +1472,17 @@ Specifies the value for attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | The code of the attribute. | +| `attribute_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The code of the attribute. | | `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the attribute. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value assigned to the attribute. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "selected_options": [AttributeInputSelectedOption], - "value": "xyz789" + "value": "abc123" } ``` @@ -1491,8 +1494,8 @@ Specifies the value for attribute. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | +| `attribute_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The attribute code. | #### Possible Types @@ -1502,7 +1505,7 @@ Specifies the value for attribute. | [`AttributeImage`](#attributeimage) | | [`AttributeSelectedOptions`](#attributeselectedoptions) | | [`AttributeValue`](#attributevalue) | -| [`ProductAttributeFile`](types-k-p.md#productattributefile) | +| [`ProductAttributeFile`](/reference/graphql/saas/types-k-p.md#productattributefile) | #### Example @@ -1521,7 +1524,7 @@ Metadata of EAV attributes associated to form | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/saas/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1543,7 +1546,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| | `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](/reference/graphql/saas/types-c-e.md#customattributemetadatainterface) | Requested attributes metadata. | #### Example @@ -1562,7 +1565,7 @@ Metadata of EAV attributes. | Field Name | Description | |------------|-------------| -| `liability_shift` - [`LiabilityShift`](types-k-p.md#liabilityshift) | Liability Shift | +| `liability_shift` - [`LiabilityShift`](/reference/graphql/saas/types-k-p.md#liabilityshift) | Liability Shift | #### Example @@ -1580,8 +1583,8 @@ Defines the code and symbol of a currency that can be used for purchase orders. | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](types-q-s.md#string) | Currency symbol, for example $. | +| `code` - [`CurrencyEnum!`](/reference/graphql/saas/types-c-e.md#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Currency symbol, for example $. | #### Example @@ -1599,10 +1602,10 @@ Describes a payment method that the shopper can use to pay for the order. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The payment method code. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The payment method code. | | `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `oope_payment_method_config` - [`OopePaymentMethodConfig`](types-k-p.md#oopepaymentmethodconfig) | Configuration for out of process payment methods | -| `title` - [`String!`](types-q-s.md#string) | The payment method title. | +| `oope_payment_method_config` - [`OopePaymentMethodConfig`](/reference/graphql/saas/types-k-p.md#oopepaymentmethodconfig) | Configuration for out of process payment methods | +| `title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The payment method title. | #### Example @@ -1625,16 +1628,16 @@ Contains details about the possible shipping methods and carriers. | Field Name | Description | |------------|-------------| -| `additional_data` - [`[ShippingAdditionalData]`](types-q-s.md#shippingadditionaldata) | Additional data related to the shipping method. | -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `additional_data` - [`[ShippingAdditionalData]`](/reference/graphql/saas/types-q-s.md#shippingadditionaldata) | Additional data related to the shipping method. | +| `amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#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!`](types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](types-q-s.md#string) | The label for the carrier code. | -| `error_message` - [`String`](types-q-s.md#string) | Describes an error condition. | -| `method_code` - [`String`](types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `carrier_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The label for the carrier code. | +| `error_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Describes an error condition. | +| `method_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -1646,7 +1649,7 @@ Contains details about the possible shipping methods and carriers. "carrier_code": "abc123", "carrier_title": "abc123", "error_message": "abc123", - "method_code": "abc123", + "method_code": "xyz789", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -1681,9 +1684,9 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `address` - [`CartAddressInput`](/reference/graphql/saas/types-c-e.md#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#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. | @@ -1692,9 +1695,9 @@ Defines the billing address. ```json { "address": CartAddressInput, - "customer_address_id": 123, + "customer_address_id": 987, "customer_address_uid": 4, - "same_as_shipping": true, + "same_as_shipping": false, "use_for_shipping": true } ``` @@ -1709,23 +1712,23 @@ The billing address information | Input Field | Description | |-------------|-------------| -| `address_line_1` - [`String`](types-q-s.md#string) | The first line of the address | -| `address_line_2` - [`String`](types-q-s.md#string) | The second line of the address | -| `city` - [`String`](types-q-s.md#string) | The city of the address | -| `country_code` - [`String!`](types-q-s.md#string) | The country of the address | -| `postal_code` - [`String`](types-q-s.md#string) | The postal code of the address | -| `region` - [`String`](types-q-s.md#string) | The region of the address | +| `address_line_1` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The first line of the address | +| `address_line_2` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The second line of the address | +| `city` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The city of the address | +| `country_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The country of the address | +| `postal_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The postal code of the address | +| `region` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The region of the address | #### Example ```json { "address_line_1": "abc123", - "address_line_2": "xyz789", + "address_line_2": "abc123", "city": "abc123", - "country_code": "xyz789", - "postal_code": "abc123", - "region": "abc123" + "country_code": "abc123", + "postal_code": "xyz789", + "region": "xyz789" } ``` @@ -1739,24 +1742,24 @@ Contains details about the billing address. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/saas/types-c-e.md#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`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](/reference/graphql/saas/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example @@ -1769,16 +1772,16 @@ Contains details about the billing address. "customer_address_uid": "4", "fax": "abc123", "firstname": "abc123", - "id": 123, + "id": 987, "lastname": "xyz789", "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": CartAddressRegion, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "uid": "4", + "suffix": "abc123", + "telephone": "abc123", + "uid": 4, "vat_id": "abc123" } ``` @@ -1805,21 +1808,21 @@ Contains details about an individual category that comprises a breadcrumb. | Field Name | Description | |------------|-------------| -| `category_level` - [`Int`](types-f-i.md#int) | The category level. | -| `category_name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `category_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](types-q-s.md#string) | The URL key of the category. | -| `category_url_path` - [`String`](types-q-s.md#string) | The URL path of the category. | +| `category_level` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The category level. | +| `category_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the category. | +| `category_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL key of the category. | +| `category_url_path` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL path of the category. | #### Example ```json { - "category_level": 987, + "category_level": 123, "category_name": "abc123", - "category_uid": 4, + "category_uid": "4", "category_url_key": "xyz789", - "category_url_path": "abc123" + "category_url_path": "xyz789" } ``` @@ -1833,17 +1836,17 @@ An interface for bucket contents | Field Name | Description | |------------|-------------| -| `title` - [`String!`](types-q-s.md#string) | A human-readable name of a bucket | +| `title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A human-readable name of a bucket | #### Possible Types | Bucket Types | |----------------| -| [`CategoryBucket`](types-c-e.md#categorybucket) | -| [`CategoryView`](types-c-e.md#categoryview) | -| [`RangeBucket`](types-q-s.md#rangebucket) | -| [`ScalarBucket`](types-q-s.md#scalarbucket) | -| [`StatsBucket`](types-q-s.md#statsbucket) | +| [`CategoryBucket`](/reference/graphql/saas/types-c-e.md#categorybucket) | +| [`CategoryView`](/reference/graphql/saas/types-c-e.md#categoryview) | +| [`RangeBucket`](/reference/graphql/saas/types-q-s.md#rangebucket) | +| [`ScalarBucket`](/reference/graphql/saas/types-q-s.md#scalarbucket) | +| [`StatsBucket`](/reference/graphql/saas/types-q-s.md#statsbucket) | #### Example @@ -1861,26 +1864,26 @@ An implementation for bundle product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/saas/types-q-s.md#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/saas/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/saas/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -1895,17 +1898,17 @@ An implementation for bundle product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, + "is_available": true, "is_salable": false, "max_qty": 123.45, - "min_qty": 987.65, - "not_available_message": "abc123", + "min_qty": 123.45, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -1919,15 +1922,15 @@ Defines bundle product options for `CreditMemoItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the credit memo item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/saas/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | #### Example @@ -1938,7 +1941,7 @@ Defines bundle product options for `CreditMemoItemInterface`. "discounts": [Discount], "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_refunded": 987.65 @@ -1955,15 +1958,15 @@ Defines bundle product options for `InvoiceItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/saas/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -1976,8 +1979,8 @@ Defines bundle product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 + "product_sku": "xyz789", + "quantity_invoiced": 123.45 } ``` @@ -1992,24 +1995,24 @@ Defines an individual item within a bundle product. | Field Name | Description | |------------|-------------| | `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | -| `position` - [`Int`](types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | | `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](types-q-s.md#string) | The SKU of the bundle product. | -| `title` - [`String`](types-q-s.md#string) | The display name of the item. | -| `type` - [`String`](types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `BundleItem` object. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the bundle product. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the item. | +| `type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `BundleItem` object. | #### Example ```json { "options": [BundleItemOption], - "position": 123, + "position": 987, "price_range": PriceRange, "required": true, "sku": "xyz789", - "title": "xyz789", + "title": "abc123", "type": "xyz789", "uid": 4 } @@ -2027,13 +2030,13 @@ Defines the characteristics that comprise a specific bundle item and its options |------------|-------------| | `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`](types-q-s.md#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](types-f-i.md#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | Contains details about this product option. | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](/reference/graphql/saas/types-k-p.md#productinterface) | Contains details about this product option. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `BundleItemOption` object. | #### Example @@ -2046,8 +2049,8 @@ Defines the characteristics that comprise a specific bundle item and its options "price": 987.65, "price_type": "FIXED", "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -2061,31 +2064,31 @@ Defines bundle product options for `OrderItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/saas/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#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]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/saas/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/saas/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the order item. | #### Example @@ -2094,26 +2097,26 @@ Defines bundle product options for `OrderItemInterface`. "bundle_options": [ItemSelectedBundleOption], "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "xyz789", + "product_sku": "xyz789", + "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, + "quantity_canceled": 123.45, + "quantity_invoiced": 987.65, "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -2129,85 +2132,85 @@ Defines basic features of a bundle product and contains multiple BundleItems. | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `canonical_url` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](/reference/graphql/saas/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/saas/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#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`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates whether the product can be returned. | | `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_details` - [`PriceDetails`](types-k-p.md#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `manufacturer` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/saas/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/saas/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_details` - [`PriceDetails`](/reference/graphql/saas/types-k-p.md#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](/reference/graphql/saas/types-k-p.md#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](/reference/graphql/saas/types-q-s.md#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/saas/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The part of the URL that identifies the product | +| `weight` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "dynamic_price": true, + "dynamic_price": false, "dynamic_sku": false, "dynamic_weight": true, - "gift_message_available": true, - "gift_wrapping_available": false, + "gift_message_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "items": [BundleItem], "manufacturer": 987, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", "price_details": PriceDetails, @@ -2215,18 +2218,18 @@ Defines basic features of a bundle product and contains multiple BundleItems. "price_tiers": [TierPrice], "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_price": 123.45, "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "abc123", "weight": 987.65 @@ -2243,12 +2246,12 @@ Contains details about bundle products added to a requisition list. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `bundle_options` - [`[SelectedBundleOption]!`](/reference/graphql/saas/types-q-s.md#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -2258,7 +2261,7 @@ Contains details about bundle products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "sku": "xyz789", + "sku": "abc123", "uid": 4 } ``` @@ -2273,20 +2276,20 @@ Defines bundle product options for `ShipmentItemInterface`. | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `bundle_options` - [`[ItemSelectedBundleOption]`](/reference/graphql/saas/types-f-i.md#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | #### Example ```json { "bundle_options": [ItemSelectedBundleOption], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -2305,25 +2308,25 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](/reference/graphql/saas/types-q-s.md#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, + "description": "xyz789", + "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -2335,11 +2338,11 @@ Defines bundle product options for `WishlistItemInterface`. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | -| `height` - [`Int`](types-f-i.md#int) | The button height in pixels | -| `label` - [`String`](types-q-s.md#string) | The button label | -| `layout` - [`String`](types-q-s.md#string) | The button layout | -| `shape` - [`String`](types-q-s.md#string) | The button shape | +| `color` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The button color | +| `height` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The button height in pixels | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The button label | +| `layout` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The button layout | +| `shape` - [`String`](/reference/graphql/saas/types-q-s.md#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 | @@ -2347,9 +2350,9 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "abc123", + "color": "xyz789", "height": 123, - "label": "abc123", + "label": "xyz789", "layout": "xyz789", "shape": "xyz789", "tagline": true, diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md index 8a6d798a5..36b340146 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md @@ -8,15 +8,15 @@ Specifies the quote template id of the quote template to cancel | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](types-q-s.md#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `cancellation_comment` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "cancellation_comment": "xyz789", - "template_id": "4" + "template_id": 4 } ``` @@ -29,14 +29,14 @@ Specifies the quote template id of the quote template to cancel | Field Name | Description | |------------|-------------| | `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "ORDER_CANCELLATION_DISABLED", - "message": "xyz789" + "message": "abc123" } ``` @@ -71,13 +71,13 @@ Defines the order to cancel. | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | +| `order_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Cancellation reason. | #### Example ```json -{"order_id": 4, "reason": "xyz789"} +{"order_id": 4, "reason": "abc123"} ``` @@ -90,7 +90,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `error` - [`String`](types-q-s.md#string) | Error encountered while cancelling the order. | +| `error` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Error encountered while cancelling the order. | | `errorV2` - [`CancelOrderError`](#cancelordererror) | | | `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | @@ -98,7 +98,7 @@ Contains the updated customer order and error message if any. ```json { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -112,7 +112,7 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `description` - [`String!`](types-q-s.md#string) | | +| `description` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -128,12 +128,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `authentication_result` - [`AuthenticationResult`](types-a-b.md#authenticationresult) | Authentication result | +| `authentication_result` - [`AuthenticationResult`](/reference/graphql/saas/types-a-b.md#authenticationresult) | Authentication result | | `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `last_digits` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `name` - [`String`](types-q-s.md#string) | Name on the card | +| `card_expiry_month` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Expiration year of the card | +| `last_digits` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Last four digits of the card | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Name on the card | #### Example @@ -142,9 +142,9 @@ Contains the updated customer order and error message if any. "authentication_result": AuthenticationResult, "bin_details": CardBin, "card_expiry_month": "xyz789", - "card_expiry_year": "abc123", + "card_expiry_year": "xyz789", "last_digits": "xyz789", - "name": "xyz789" + "name": "abc123" } ``` @@ -156,12 +156,12 @@ Contains the updated customer order and error message if any. | Field Name | Description | |------------|-------------| -| `bin` - [`String`](types-q-s.md#string) | Card bin number | +| `bin` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Card bin number | #### Example ```json -{"bin": "abc123"} +{"bin": "xyz789"} ``` @@ -174,8 +174,8 @@ The card payment source information | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](types-q-s.md#string) | The name on the cardholder | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](/reference/graphql/saas/types-a-b.md#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name on the cardholder | #### Example @@ -196,16 +196,16 @@ The card payment source information | Field Name | Description | |------------|-------------| -| `brand` - [`String`](types-q-s.md#string) | The brand of the card | -| `expiry` - [`String`](types-q-s.md#string) | The expiry of the card | -| `last_digits` - [`String`](types-q-s.md#string) | The last digits of the card | +| `brand` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The brand of the card | +| `expiry` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The expiry of the card | +| `last_digits` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The last digits of the card | #### Example ```json { - "brand": "xyz789", - "expiry": "xyz789", + "brand": "abc123", + "expiry": "abc123", "last_digits": "xyz789" } ``` @@ -220,27 +220,27 @@ Contains the contents and other details about a guest or customer cart. | Field Name | Description | |------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]`](types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | +| `applied_coupons` - [`[AppliedCoupon]`](/reference/graphql/saas/types-a-b.md#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](/reference/graphql/saas/types-a-b.md#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](/reference/graphql/saas/types-q-s.md#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](/reference/graphql/saas/types-a-b.md#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/saas/types-a-b.md#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](/reference/graphql/saas/types-a-b.md#billingcartaddress) | The billing address assigned to the cart. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart | -| `email` - [`String`](types-q-s.md#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart contains only virtual products. | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the cart contains only virtual products. | | `itemsV2` - [`CartItems`](#cartitems) | | | `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/saas/types-q-s.md#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](/reference/graphql/saas/types-q-s.md#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The total number of items in the cart. | #### Example @@ -254,12 +254,12 @@ Contains the contents and other details about a guest or customer cart. "available_payment_methods": [AvailablePaymentMethod], "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": true, @@ -280,15 +280,15 @@ Contains details the country in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The country code. | -| `label` - [`String!`](types-q-s.md#string) | The display label for the country. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The country code. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display label for the country. | #### Example ```json { - "code": "abc123", - "label": "abc123" + "code": "xyz789", + "label": "xyz789" } ``` @@ -302,44 +302,44 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/saas/types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example ```json { "city": "xyz789", - "company": "xyz789", - "country_code": "xyz789", + "company": "abc123", + "country_code": "abc123", "custom_attributes": [AttributeValueInput], - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "abc123", "prefix": "xyz789", - "region": "xyz789", - "region_id": 987, + "region": "abc123", + "region_id": 123, "save_in_address_book": true, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", + "suffix": "abc123", + "telephone": "xyz789", "vat_id": "abc123" } ``` @@ -352,31 +352,31 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company specified for the billing or shipping address. | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company specified for the billing or shipping address. | | `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the customer or guest. | -| `id` - [`Int`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the customer or guest. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the customer or guest. | +| `id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the customer or guest. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | | `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](types-q-s.md#string) | The VAT company number for billing or shipping address. | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Possible Types | CartAddressInterface Types | |----------------| -| [`BillingCartAddress`](types-a-b.md#billingcartaddress) | -| [`ShippingCartAddress`](types-q-s.md#shippingcartaddress) | +| [`BillingCartAddress`](/reference/graphql/saas/types-a-b.md#billingcartaddress) | +| [`ShippingCartAddress`](/reference/graphql/saas/types-q-s.md#shippingcartaddress) | #### Example @@ -386,16 +386,16 @@ Defines the billing or shipping address to be applied to the cart. "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", - "firstname": "abc123", + "customer_address_uid": "4", + "fax": "abc123", + "firstname": "xyz789", "id": 987, "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "xyz789", "uid": "4", @@ -413,17 +413,17 @@ Contains details about the region in a billing or shipping address. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The state or province code. | -| `label` - [`String`](types-q-s.md#string) | The display label for the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The state or province code. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display label for the region. | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "abc123", - "region_id": 987 + "region_id": 123 } ``` @@ -437,14 +437,14 @@ Defines a cart custom attributes. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The cart ID. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The cart ID. | | `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "custom_attributes": [CustomAttributeInput] } ``` @@ -476,8 +476,8 @@ Defines a cart item custom attributes. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The cart ID. | -| `cart_item_id` - [`String!`](types-q-s.md#string) | The cart item ID. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The cart ID. | +| `cart_item_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The cart item ID. | | `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart item. | #### Example @@ -499,12 +499,12 @@ Defines a cart item custom attributes. | Field Name | Description | |------------|-------------| | `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](types-q-s.md#string) | A localized error message | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message | #### Example ```json -{"code": "UNDEFINED", "message": "abc123"} +{"code": "UNDEFINED", "message": "xyz789"} ``` @@ -536,10 +536,10 @@ Defines an item to be added to the cart. | Input Field | Description | |-------------|-------------| | `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](types-q-s.md#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](types-f-i.md#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!`](types-q-s.md#string) | The SKU of the product. | +| `parent_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the product. | #### Example @@ -547,9 +547,9 @@ Defines an item to be added to the cart. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["4"], - "sku": "abc123" + "quantity": 987.65, + "selected_options": [4], + "sku": "xyz789" } ``` @@ -563,32 +563,32 @@ An interface for products in a cart. | Field Name | Description | |------------|-------------| -| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `backorder_message` - [`String`](/reference/graphql/saas/types-q-s.md#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!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `is_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Possible Types | CartItemInterface Types | |----------------| -| [`BundleCartItem`](types-a-b.md#bundlecartitem) | +| [`BundleCartItem`](/reference/graphql/saas/types-a-b.md#bundlecartitem) | | [`ConfigurableCartItem`](#configurablecartitem) | | [`DownloadableCartItem`](#downloadablecartitem) | -| [`GiftCardCartItem`](types-f-i.md#giftcardcartitem) | -| [`SimpleCartItem`](types-q-s.md#simplecartitem) | -| [`VirtualCartItem`](types-t-z.md#virtualcartitem) | +| [`GiftCardCartItem`](/reference/graphql/saas/types-f-i.md#giftcardcartitem) | +| [`SimpleCartItem`](/reference/graphql/saas/types-q-s.md#simplecartitem) | +| [`VirtualCartItem`](/reference/graphql/saas/types-t-z.md#virtualcartitem) | #### Example @@ -599,7 +599,7 @@ An interface for products in a cart. "discount": [Discount], "errors": [CartItemError], "is_available": false, - "is_salable": false, + "is_salable": true, "max_qty": 123.45, "min_qty": 123.45, "not_available_message": "xyz789", @@ -608,7 +608,7 @@ An interface for products in a cart. "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -622,17 +622,17 @@ Contains details about the price of the item, including taxes and discounts. | Field Name | Description | |------------|-------------| -| `catalog_discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | +| `catalog_discount` - [`ProductDiscount`](/reference/graphql/saas/types-k-p.md#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]`](types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | -| `original_item_price` - [`Money!`](types-k-p.md#money) | The value of the original unit price for the item, including discounts. | -| `original_row_total` - [`Money!`](types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | -| `price` - [`Money!`](types-k-p.md#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!`](types-k-p.md#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`](types-k-p.md#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!`](types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](types-k-p.md#money) | The total of all discounts applied to the item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/saas/types-f-i.md#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](/reference/graphql/saas/types-k-p.md#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!`](/reference/graphql/saas/types-k-p.md#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`](/reference/graphql/saas/types-k-p.md#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!`](/reference/graphql/saas/types-k-p.md#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The total of all discounts applied to the item. | #### Example @@ -662,9 +662,9 @@ Contains details about the price of a selected customizable value. | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](types-q-s.md#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](types-f-i.md#float) | A price value. | +| `type` - [`PriceTypeEnum!`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | A price value. | #### Example @@ -672,7 +672,7 @@ Contains details about the price of a selected customizable value. { "type": "FIXED", "units": "abc123", - "value": 123.45 + "value": 987.65 } ``` @@ -686,20 +686,20 @@ A single item to be updated. | Input Field | Description | |-------------|-------------| -| `cart_item_uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `cart_item_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | | `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/saas/types-f-i.md#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The new quantity of the item. | #### Example ```json { - "cart_item_uid": 4, + "cart_item_uid": "4", "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, - "gift_wrapping_id": "4", + "gift_wrapping_id": 4, "quantity": 123.45 } ``` @@ -713,8 +713,8 @@ A single item to be updated. | Field Name | Description | |------------|-------------| | `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of returned cart items. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of returned cart items. | #### Example @@ -737,14 +737,14 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| | `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | -| `custom_fees` - [`[OopeCustomFee]`](types-k-p.md#oopecustomfee) | Custom fees applied to the cart via out-of-process webhooks. | +| `custom_fees` - [`[OopeCustomFee]`](/reference/graphql/saas/types-k-p.md#oopecustomfee) | Custom fees applied to the cart via out-of-process webhooks. | | `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | -| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | -| `grand_total_excluding_tax` - [`Money`](types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | -| `subtotal_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](types-k-p.md#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/saas/types-f-i.md#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The subtotal with any discounts applied, but not taxes. | #### Example @@ -770,7 +770,7 @@ Contains details about the final price of items in the cart, including discount | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartRule` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartRule` object. | #### Example @@ -788,8 +788,8 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `label` - [`String!`](types-q-s.md#string) | The description of the tax. | +| `amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The amount of tax applied to the item. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The description of the tax. | #### Example @@ -809,7 +809,7 @@ Contains tax information about an item in the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | #### Example @@ -876,29 +876,29 @@ Swatch attribute metadata. | Field Name | Description | |------------|-------------| | `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/saas/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/saas/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](types-a-b.md#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](types-a-b.md#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](/reference/graphql/saas/types-q-s.md#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example @@ -906,26 +906,26 @@ Swatch attribute metadata. { "apply_to": ["SIMPLE"], "code": 4, - "default_value": "abc123", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_comparable": true, + "is_comparable": false, "is_filterable": false, "is_filterable_in_search": true, - "is_html_allowed_on_front": false, - "is_required": false, + "is_html_allowed_on_front": true, + "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_used_for_promo_rules": true, + "is_visible_in_advanced_search": true, + "is_visible_on_front": true, "is_wysiwyg_enabled": false, - "label": "xyz789", + "label": "abc123", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", - "update_product_preview_image": false, + "update_product_preview_image": true, "use_product_image_for_swatch": false, "used_in_product_listing": true } @@ -941,17 +941,17 @@ New category bucket for federation | Field Name | Description | |------------|-------------| -| `count` - [`Int!`](types-f-i.md#int) | | -| `id` - [`ID!`](types-f-i.md#id) | | -| `path` - [`String!`](types-q-s.md#string) | | -| `title` - [`String!`](types-q-s.md#string) | | +| `count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | +| `path` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | +| `title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example ```json { - "count": 987, - "id": 4, + "count": 123, + "id": "4", "path": "abc123", "title": "xyz789" } @@ -965,7 +965,7 @@ New category bucket for federation | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | | #### Possible Types @@ -989,31 +989,31 @@ Contains the full set of attributes that can be returned in a category search. | Field Name | Description | |------------|-------------| -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `available_sort_by` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/saas/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/saas/types-q-s.md#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`](/reference/graphql/saas/types-q-s.md#string) | | +| `custom_layout_update_file` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | | +| `image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL path assigned to the category. | #### Possible Types @@ -1025,15 +1025,15 @@ Contains the full set of attributes that can be returned in a category search. ```json { - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "abc123", "children_count": "xyz789", "custom_layout_update_file": "xyz789", "default_sort_by": "abc123", "description": "abc123", - "display_mode": "abc123", - "filter_price_range": 987.65, + "display_mode": "xyz789", + "filter_price_range": 123.45, "image": "xyz789", "include_in_menu": 987, "is_anchor": 123, @@ -1041,15 +1041,15 @@ Contains the full set of attributes that can be returned in a category search. "level": 123, "meta_description": "xyz789", "meta_keywords": "abc123", - "meta_title": "abc123", + "meta_title": "xyz789", "name": "abc123", "path": "xyz789", - "path_in_store": "abc123", - "position": 987, + "path_in_store": "xyz789", + "position": 123, "product_count": 987, "uid": 4, - "url_key": "abc123", - "url_path": "abc123" + "url_key": "xyz789", + "url_path": "xyz789" } ``` @@ -1063,31 +1063,31 @@ Contains the hierarchy of categories. | Field Name | Description | |------------|-------------| -| `available_sort_by` - [`[String]`](types-q-s.md#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](types-a-b.md#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](types-q-s.md#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`](types-q-s.md#string) | | -| `custom_layout_update_file` - [`String`](types-q-s.md#string) | | -| `default_sort_by` - [`String`](types-q-s.md#string) | The attribute to use for sorting. | -| `description` - [`String`](types-q-s.md#string) | An optional description of the category. | -| `display_mode` - [`String`](types-q-s.md#string) | | -| `filter_price_range` - [`Float`](types-f-i.md#float) | | -| `image` - [`String`](types-q-s.md#string) | | -| `include_in_menu` - [`Int`](types-f-i.md#int) | | -| `is_anchor` - [`Int`](types-f-i.md#int) | | -| `landing_page` - [`Int`](types-f-i.md#int) | | -| `level` - [`Int`](types-f-i.md#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](types-q-s.md#string) | | -| `meta_keywords` - [`String`](types-q-s.md#string) | | -| `meta_title` - [`String`](types-q-s.md#string) | | -| `name` - [`String`](types-q-s.md#string) | The display name of the category. | -| `path` - [`String`](types-q-s.md#string) | The full category path. | -| `path_in_store` - [`String`](types-q-s.md#string) | The category path within the store. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `url_key` - [`String`](types-q-s.md#string) | The URL key assigned to the category. | -| `url_path` - [`String`](types-q-s.md#string) | The URL path assigned to the category. | +| `available_sort_by` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](/reference/graphql/saas/types-a-b.md#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](/reference/graphql/saas/types-q-s.md#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`](/reference/graphql/saas/types-q-s.md#string) | | +| `custom_layout_update_file` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `default_sort_by` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The attribute to use for sorting. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An optional description of the category. | +| `display_mode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `filter_price_range` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | | +| `image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `include_in_menu` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `is_anchor` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `landing_page` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `level` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `meta_keywords` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the category. | +| `path` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full category path. | +| `path_in_store` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The category path within the store. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL key assigned to the category. | +| `url_path` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL path assigned to the category. | #### Example @@ -1095,29 +1095,29 @@ Contains the hierarchy of categories. { "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", - "children_count": "xyz789", + "canonical_url": "xyz789", + "children_count": "abc123", "custom_layout_update_file": "xyz789", - "default_sort_by": "abc123", - "description": "xyz789", + "default_sort_by": "xyz789", + "description": "abc123", "display_mode": "xyz789", - "filter_price_range": 123.45, - "image": "xyz789", - "include_in_menu": 987, + "filter_price_range": 987.65, + "image": "abc123", + "include_in_menu": 123, "is_anchor": 987, - "landing_page": 123, + "landing_page": 987, "level": 123, "meta_description": "xyz789", "meta_keywords": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "name": "xyz789", - "path": "abc123", + "path": "xyz789", "path_in_store": "xyz789", "position": 123, "product_count": 987, "uid": "4", "url_key": "xyz789", - "url_path": "xyz789" + "url_path": "abc123" } ``` @@ -1131,20 +1131,20 @@ Represents a category. Contains information about a category, including the cate | Field Name | Description | |------------|-------------| -| `availableSortBy` - [`[String]`](types-q-s.md#string) | List of available sort by options. For example, `name`, `position` or `size`. | -| `children` - [`[String!]`](types-q-s.md#string) | List of child category IDs. For example, `123`, `456` or `789`. | -| `defaultSortBy` - [`String`](types-q-s.md#string) | Default sort by option. For example, `name`, `position` or `size`. | -| `id` - [`ID!`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | -| `parentId` - [`String!`](types-q-s.md#string) | Parent category ID. For example, `123`, `456` or `789`. | -| `position` - [`Int`](types-f-i.md#int) | The position of the category in sort order. For example, `1`, `2`, `3` or `10`. | -| `path` - [`String`](types-q-s.md#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!]!`](types-q-s.md#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | -| `urlKey` - [`String`](types-q-s.md#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | -| `urlPath` - [`String`](types-q-s.md#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | -| `count` - [`Int!`](types-f-i.md#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!`](types-q-s.md#string) | *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | +| `availableSortBy` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | List of available sort by options. For example, `name`, `position` or `size`. | +| `children` - [`[String!]`](/reference/graphql/saas/types-q-s.md#string) | List of child category IDs. For example, `123`, `456` or `789`. | +| `defaultSortBy` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Default sort by option. For example, `name`, `position` or `size`. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-q-s.md#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | +| `parentId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Parent category ID. For example, `123`, `456` or `789`. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The position of the category in sort order. For example, `1`, `2`, `3` or `10`. | +| `path` - [`String`](/reference/graphql/saas/types-q-s.md#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!]!`](/reference/graphql/saas/types-q-s.md#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `urlKey` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | +| `urlPath` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | +| `count` - [`Int!`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-q-s.md#string) | *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | #### Example @@ -1152,17 +1152,17 @@ Represents a category. Contains information about a category, including the cate { "availableSortBy": ["abc123"], "children": ["xyz789"], - "defaultSortBy": "abc123", + "defaultSortBy": "xyz789", "id": 4, - "level": 987, + "level": 123, "name": "xyz789", - "parentId": "abc123", - "position": 123, - "path": "abc123", - "roles": ["abc123"], + "parentId": "xyz789", + "position": 987, + "path": "xyz789", + "roles": ["xyz789"], "urlKey": "abc123", "urlPath": "xyz789", - "count": 987, + "count": 123, "title": "abc123" } ``` @@ -1177,15 +1177,15 @@ Base interface defining essential category fields shared across all category vie | Field Name | Description | |------------|-------------| -| `availableSortBy` - [`[String]`](types-q-s.md#string) | List of available sort by options. For example, name, size or position. | -| `defaultSortBy` - [`String`](types-q-s.md#string) | Default sort by option. For example, name, size or position. | -| `id` - [`ID!`](types-f-i.md#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`](types-f-i.md#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`](types-q-s.md#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | -| `path` - [`String`](types-q-s.md#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | -| `roles` - [`[String]`](types-q-s.md#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | -| `urlKey` - [`String`](types-q-s.md#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | -| `urlPath` - [`String`](types-q-s.md#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | +| `availableSortBy` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | List of available sort by options. For example, name, size or position. | +| `defaultSortBy` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Default sort by option. For example, name, size or position. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-q-s.md#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | +| `path` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | +| `roles` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `urlKey` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | +| `urlPath` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | #### Possible Types @@ -1197,13 +1197,13 @@ Base interface defining essential category fields shared across all category vie ```json { - "availableSortBy": ["abc123"], + "availableSortBy": ["xyz789"], "defaultSortBy": "xyz789", "id": "4", - "level": 987, - "name": "xyz789", + "level": 123, + "name": "abc123", "path": "xyz789", - "roles": ["xyz789"], + "roles": ["abc123"], "urlKey": "abc123", "urlPath": "abc123" } @@ -1219,25 +1219,25 @@ Defines details about an individual checkout agreement. | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](types-f-i.md#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](types-q-s.md#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](types-q-s.md#string) | Required. The text of the agreement. | -| `content_height` - [`String`](types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | +| `agreement_id` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Required. The text of the agreement. | +| `content_height` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the `content` text is in HTML format. | | `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](types-q-s.md#string) | The name given to the condition. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name given to the condition. | #### Example ```json { - "agreement_id": 987, + "agreement_id": 123, "checkbox_text": "xyz789", - "content": "abc123", + "content": "xyz789", "content_height": "abc123", "is_html": false, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ``` @@ -1271,8 +1271,8 @@ An error encountered while adding an item to the cart. | Field Name | Description | |------------|-------------| | `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `path` - [`[String]!`](types-q-s.md#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 | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | +| `path` - [`[String]!`](/reference/graphql/saas/types-q-s.md#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 @@ -1280,7 +1280,7 @@ An error encountered while adding an item to the cart. { "code": "REORDER_NOT_AVAILABLE", "message": "abc123", - "path": ["abc123"] + "path": ["xyz789"] } ``` @@ -1315,7 +1315,7 @@ Output of the request to clear the customer cart. | Field Name | Description | |------------|-------------| | `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether cart was cleared. | +| `status` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether cart was cleared. | #### Example @@ -1331,9 +1331,9 @@ Output of the request to clear the customer cart. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/saas/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/saas/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/saas/types-f-i.md#internalerror) | #### Example @@ -1352,7 +1352,7 @@ Contains details about a failed close operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -1371,7 +1371,7 @@ Contains details about a failed close operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/saas/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example @@ -1390,12 +1390,12 @@ Defines the negotiable quotes to mark as closed. | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `quote_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -1408,9 +1408,9 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/saas/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/saas/types-a-b.md#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example @@ -1432,7 +1432,7 @@ Contains the closed negotiable quotes and other negotiable quotes the company us | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -1450,7 +1450,7 @@ Commerce Optimizer entities | Field Name | Description | |------------|-------------| -| `priceBookId` - [`ID!`](types-f-i.md#id) | The priceBookId for current customer session. | +| `priceBookId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The priceBookId for current customer session. | #### Example @@ -1487,7 +1487,7 @@ Specifies which field to sort on, and whether to return the results in ascending | Input Field | Description | |-------------|-------------| | `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | +| `order` - [`SortEnum!`](/reference/graphql/saas/types-q-s.md#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example @@ -1506,19 +1506,19 @@ Contains the output schema for a company. | Field Name | Description | |------------|-------------| | `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | Available payment methods for the company with proper B2B configuration and company-specific filtering. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#string) | The email address of the company contact. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the company contact. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | -| `payment_methods` - [`[String]`](types-q-s.md#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the company. | +| `payment_methods` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](/reference/graphql/saas/types-q-s.md#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. | @@ -1527,7 +1527,7 @@ Contains the output schema for a company. | `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`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example @@ -1545,7 +1545,7 @@ Contains the output schema for a company. "email": "xyz789", "id": "4", "legal_address": CompanyLegalAddress, - "legal_name": "xyz789", + "legal_name": "abc123", "name": "abc123", "payment_methods": ["abc123"], "reseller_id": "xyz789", @@ -1572,9 +1572,9 @@ Contains details about the access control list settings of a resource. | Field Name | Description | |------------|-------------| | `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](types-f-i.md#int) | The sort order of an ACL resource. | -| `text` - [`String`](types-q-s.md#string) | The label assigned to the ACL resource. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The sort order of an ACL resource. | +| `text` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to the ACL resource. | #### Example @@ -1583,7 +1583,7 @@ Contains details about the access control list settings of a resource. "children": [CompanyAclResource], "id": "4", "sort_order": 123, - "text": "xyz789" + "text": "abc123" } ``` @@ -1597,25 +1597,25 @@ Defines the input schema for creating a company administrator. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the company administrator. | -| `firstname` - [`String!`](types-q-s.md#string) | The company administrator's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](types-q-s.md#string) | The job title of the company administrator. | -| `lastname` - [`String!`](types-q-s.md#string) | The company administrator's last name. | -| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company administrator. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/saas/types-a-b.md#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address of the company administrator. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company administrator's first name. | +| `gender` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The job title of the company administrator. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company administrator's last name. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The phone number of the company administrator. | #### Example ```json { "custom_attributes": [AttributeValueInput], - "email": "xyz789", - "firstname": "abc123", - "gender": 987, + "email": "abc123", + "firstname": "xyz789", + "gender": 123, "job_title": "abc123", "lastname": "abc123", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1629,14 +1629,14 @@ Describes a carrier-level shipping option available to the company. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | | -| `title` - [`String!`](types-q-s.md#string) | | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | +| `title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example ```json { - "code": "abc123", + "code": "xyz789", "title": "xyz789" } ``` @@ -1651,10 +1651,10 @@ The minimal required information to identify and display the company. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Company` object. | -| `is_admin` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company is the admin (parent) company in the returned relation hierarchy. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `name` - [`String`](types-q-s.md#string) | The name of the company. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `Company` object. | +| `is_admin` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the company is the admin (parent) company in the returned relation hierarchy. | +| `legal_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full legal name of the company. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the company. | | `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | #### Example @@ -1662,9 +1662,9 @@ The minimal required information to identify and display the company. ```json { "id": 4, - "is_admin": false, + "is_admin": true, "legal_name": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "PENDING" } ``` @@ -1680,22 +1680,22 @@ Defines the input schema for creating a new company. | Input Field | Description | |-------------|-------------| | `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String!`](types-q-s.md#string) | The name of the company to create. | +| `company_email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the company to create. | | `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { "company_admin": CompanyAdminInput, - "company_email": "xyz789", - "company_name": "xyz789", + "company_email": "abc123", + "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "xyz789", "vat_tax_id": "xyz789" } @@ -1711,10 +1711,10 @@ Contains company credit balances and limits. | Field Name | Description | |------------|-------------| -| `available_credit` - [`Money!`](types-k-p.md#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!`](types-k-p.md#money) | The amount of credit extended to the company. | -| `exceed_limit` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether company credit functionality is allowed to exceed current company credit limit. | -| `outstanding_balance` - [`Money!`](types-k-p.md#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. | +| `available_credit` - [`Money!`](/reference/graphql/saas/types-k-p.md#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!`](/reference/graphql/saas/types-k-p.md#money) | The amount of credit extended to the company. | +| `exceed_limit` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether company credit functionality is allowed to exceed current company credit limit. | +| `outstanding_balance` - [`Money!`](/reference/graphql/saas/types-k-p.md#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 @@ -1722,7 +1722,7 @@ Contains company credit balances and limits. { "available_credit": Money, "credit_limit": Money, - "exceed_limit": true, + "exceed_limit": false, "outstanding_balance": Money } ``` @@ -1738,8 +1738,8 @@ Contains details about prior company credit operations. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of the company credit operations matching the specified filter. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The number of the company credit operations matching the specified filter. | #### Example @@ -1761,9 +1761,9 @@ Defines a filter for narrowing the results of a credit history search. | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `custom_reference_number` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The name of the person submitting the company credit operation. | +| `updated_by` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the person submitting the company credit operation. | #### Example @@ -1785,10 +1785,10 @@ Contains details about a single company credit operation. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the company credit operation. | +| `amount` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The amount of the company credit operation. | | `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](types-q-s.md#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](types-q-s.md#string) | The date the operation occurred. | +| `custom_reference_number` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](/reference/graphql/saas/types-q-s.md#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. | @@ -1836,13 +1836,13 @@ Defines the administrator or company user that submitted a company credit operat | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the company user submitting the company credit operation. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#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"} +{"name": "abc123", "type": "CUSTOMER"} ``` @@ -1894,16 +1894,16 @@ Defines the input schema for accepting the company invitation. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The invitation code. | -| `role_id` - [`ID`](types-f-i.md#id) | The company role id. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The invitation code. | +| `role_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The company role id. | | `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "code": "abc123", - "role_id": 4, + "code": "xyz789", + "role_id": "4", "user": CompanyInvitationUserInput } ``` @@ -1918,7 +1918,7 @@ The result of accepting the company invitation. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | +| `success` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer was added to the company successfully. | #### Example @@ -1936,19 +1936,19 @@ Company user attributes in the invitation. | Input Field | Description | |-------------|-------------| -| `company_id` - [`ID!`](types-f-i.md#id) | The company unique identifier. | -| `customer_id` - [`ID!`](types-f-i.md#id) | The customer unique identifier. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | +| `company_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The company unique identifier. | +| `customer_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The customer unique identifier. | +| `job_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The job title of a company user. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The phone number of the company user. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The phone number of the company user. | #### Example ```json { - "company_id": "4", - "customer_id": "4", - "job_title": "xyz789", + "company_id": 4, + "customer_id": 4, + "job_title": "abc123", "status": "ACTIVE", "telephone": "abc123" } @@ -1964,23 +1964,23 @@ Contains details about the address where the company is registered to conduct bu | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The company's postal code. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company's postal code. | | `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](types-q-s.md#string) | The company's phone number. | +| `street` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company's phone number. | #### Example ```json { - "city": "xyz789", + "city": "abc123", "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegion, "street": ["abc123"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1994,12 +1994,12 @@ Defines the input schema for defining a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#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!`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String!`](/reference/graphql/saas/types-q-s.md#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]!`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The primary phone number of the company. | #### Example @@ -2007,9 +2007,9 @@ Defines the input schema for defining a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "abc123" } ``` @@ -2024,22 +2024,22 @@ Defines the input schema for updating a company's legal address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The city where the company is registered to conduct business. | +| `city` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The city where the company is registered to conduct business. | | `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](types-q-s.md#string) | The postal code of the company. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](types-q-s.md#string) | The primary phone number of the company. | +| `street` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The primary phone number of the company. | #### Example ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", "postcode": "abc123", "region": CustomerAddressRegionInput, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "abc123" } ``` @@ -2054,16 +2054,16 @@ Contails details about a single role. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name assigned to the role. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name assigned to the role. | | `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](types-f-i.md#int) | The total number of users assigned the specified role. | +| `users_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The total number of users assigned the specified role. | #### Example ```json { - "id": "4", + "id": 4, "name": "abc123", "permissions": [CompanyAclResource], "users_count": 987 @@ -2080,8 +2080,8 @@ Defines the input schema for creating a company role. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the role to create. | -| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the role to create. | +| `permissions` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | A list of resources the role can access. | #### Example @@ -2102,9 +2102,9 @@ Defines the input schema for updating a company role. | Input Field | Description | |-------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](types-q-s.md#string) | The name of the role to update. | -| `permissions` - [`[String]`](types-q-s.md#string) | A list of resources the role can access. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the role to update. | +| `permissions` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | A list of resources the role can access. | #### Example @@ -2127,8 +2127,8 @@ Contains an array of roles. | Field Name | Description | |------------|-------------| | `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The total number of objects matching the specified filter. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The total number of objects matching the specified filter. | #### Example @@ -2136,7 +2136,7 @@ Contains an array of roles. { "items": [CompanyRole], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2150,15 +2150,15 @@ Contains details about a company sales representative. | Field Name | Description | |------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The email address of the company sales representative. | -| `firstname` - [`String`](types-q-s.md#string) | The company sales representative's first name. | -| `lastname` - [`String`](types-q-s.md#string) | The company sales representative's last name. | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the company sales representative. | +| `firstname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company sales representative's first name. | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company sales representative's last name. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "lastname": "abc123" } @@ -2231,8 +2231,8 @@ Defines an individual node in the company structure. | Field Name | Description | |------------|-------------| | `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](types-f-i.md#id) | The ID of the parent item in the company hierarchy. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of the parent item in the company hierarchy. | #### Example @@ -2240,7 +2240,7 @@ Defines an individual node in the company structure. { "entity": CompanyTeam, "id": "4", - "parent_id": 4 + "parent_id": "4" } ``` @@ -2254,13 +2254,13 @@ Defines the input schema for updating the company structure. | Input Field | Description | |-------------|-------------| -| `parent_tree_id` - [`ID!`](types-f-i.md#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](types-f-i.md#id) | The ID of the company team that is being moved to another parent. | +| `parent_tree_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{"parent_tree_id": 4, "tree_id": "4"} +{"parent_tree_id": 4, "tree_id": 4} ``` @@ -2273,19 +2273,19 @@ Describes a company team. | Field Name | Description | |------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | -| `structure_id` - [`ID!`](types-f-i.md#id) | ID of the company structure | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the team. | +| `structure_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | ID of the company structure | #### Example ```json { - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "name": "xyz789", - "structure_id": "4" + "structure_id": 4 } ``` @@ -2299,9 +2299,9 @@ Defines the input schema for creating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `name` - [`String!`](types-q-s.md#string) | The display name of the team. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An optional description of the team. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the team. | +| `target_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example @@ -2309,7 +2309,7 @@ Defines the input schema for creating a company team. { "description": "xyz789", "name": "xyz789", - "target_id": "4" + "target_id": 4 } ``` @@ -2323,17 +2323,17 @@ Defines the input schema for updating a company team. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the team. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](types-q-s.md#string) | The display name of the team. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An optional description of the team. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the team. | #### Example ```json { "description": "abc123", - "id": "4", - "name": "abc123" + "id": 4, + "name": "xyz789" } ``` @@ -2347,23 +2347,23 @@ Defines the input schema for updating a company. | Input Field | Description | |-------------|-------------| -| `company_email` - [`String`](types-q-s.md#string) | The email address of the company contact. | -| `company_name` - [`String`](types-q-s.md#string) | The name of the company to update. | +| `company_email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the company contact. | +| `company_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the company to update. | | `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](types-q-s.md#string) | The full legal name of the company. | -| `reseller_id` - [`String`](types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `legal_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full legal name of the company. | +| `reseller_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { "company_email": "xyz789", - "company_name": "abc123", + "company_name": "xyz789", "legal_address": CompanyLegalAddressUpdateInput, "legal_name": "xyz789", "reseller_id": "xyz789", - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } ``` @@ -2377,27 +2377,27 @@ Defines the input schema for creating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | The company user's email address | -| `firstname` - [`String!`](types-q-s.md#string) | The company user's first name. | -| `job_title` - [`String!`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String!`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company user's email address | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company user's first name. | +| `job_title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`ID`](types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | -| `telephone` - [`String!`](types-q-s.md#string) | The company user's phone number. | +| `target_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of a node within a company's structure. This ID will be the parent of the created company user. | +| `telephone` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "job_title": "xyz789", - "lastname": "xyz789", + "job_title": "abc123", + "lastname": "abc123", "role_id": "4", "status": "ACTIVE", - "target_id": "4", - "telephone": "xyz789" + "target_id": 4, + "telephone": "abc123" } ``` @@ -2430,23 +2430,23 @@ Defines the input schema for updating a company user. | Input Field | Description | |-------------|-------------| -| `email` - [`String`](types-q-s.md#string) | The company user's email address. | -| `firstname` - [`String`](types-q-s.md#string) | The company user's first name. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](types-q-s.md#string) | The company user's job title or function. | -| `lastname` - [`String`](types-q-s.md#string) | The company user's last name. | -| `role_id` - [`ID`](types-f-i.md#id) | The unique ID for a `CompanyRole` object. | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company user's email address. | +| `firstname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company user's first name. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company user's job title or function. | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company user's last name. | +| `role_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CompanyRole` object. | | `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](types-q-s.md#string) | The company user's phone number. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company user's phone number. | #### Example ```json { - "email": "abc123", - "firstname": "abc123", + "email": "xyz789", + "firstname": "xyz789", "id": "4", - "job_title": "abc123", + "job_title": "xyz789", "lastname": "xyz789", "role_id": "4", "status": "ACTIVE", @@ -2465,8 +2465,8 @@ Contains details about company users. | Field Name | Description | |------------|-------------| | `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of objects returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of objects returned. | #### Example @@ -2506,14 +2506,14 @@ Contains an attribute code that is used for product comparisons. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](types-q-s.md#string) | The label of the attribute code. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The label of the attribute code. | #### Example ```json { - "code": "abc123", + "code": "xyz789", "label": "abc123" } ``` @@ -2528,9 +2528,9 @@ Defines an object used to iterate through items for product comparisons. | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a product in a compare list. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a compare list. | +| `attributes` - [`[ProductAttribute]!`](/reference/graphql/saas/types-k-p.md#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about a product in a compare list. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an item in a compare list. | #### Example @@ -2553,9 +2553,9 @@ Contains iterable information such as the array of items, the count, and attribu | Field Name | Description | |------------|-------------| | `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](types-f-i.md#int) | The number of items in the compare list. | +| `item_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of items in the compare list. | | `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID assigned to the compare list. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID assigned to the compare list. | #### Example @@ -2578,8 +2578,8 @@ Update the quote and complete the order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `id` - [`String!`](types-q-s.md#string) | PayPal order ID | +| `cartId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer cart ID | +| `id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | PayPal order ID | #### Example @@ -2600,40 +2600,40 @@ Represents all product types, except simple products. Complex product prices are | Field Name | Description | |------------|-------------| -| `addToCartAllowed` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | -| `inStock` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | -| `lowStock` - [`Boolean`](types-a-b.md#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]`](types-k-p.md#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. | -| `description` - [`String`](types-q-s.md#string) | The detailed description of the product. | -| `id` - [`ID!`](types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | -| `images` - [`[ProductViewImage]`](types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image` or `swatch`. | -| `videos` - [`[ProductViewVideo]`](types-k-p.md#productviewvideo) | A list of videos defined for the product. | +| `addToCartAllowed` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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]`](/reference/graphql/saas/types-k-p.md#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The detailed description of the product. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | +| `images` - [`[ProductViewImage]`](/reference/graphql/saas/types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image` or `swatch`. | +| `videos` - [`[ProductViewVideo]`](/reference/graphql/saas/types-k-p.md#productviewvideo) | A list of videos defined for the product. | | `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | -| `metaDescription` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings. | -| `metaKeyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `metaTitle` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | Product name. | -| `inputOptions` - [`[ProductViewInputOption]`](types-k-p.md#productviewinputoption) | A list of input options. *(Deprecated: This field is deprecated and will be removed.)* | -| `options` - [`[ProductViewOption]`](types-k-p.md#productviewoption) | A list of selectable options. | -| `priceRange` - [`ProductViewPriceRange`](types-k-p.md#productviewpricerange) | A range of possible prices for a complex product. | -| `shortDescription` - [`String`](types-q-s.md#string) | A summary of the product. | -| `sku` - [`String`](types-q-s.md#string) | A unique code used for identification of a product. | -| `externalId` - [`String`](types-q-s.md#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | -| `url` - [`String`](types-q-s.md#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | -| `urlKey` - [`String`](types-q-s.md#string) | The URL key of the product. | -| `links` - [`[ProductViewLink]`](types-k-p.md#productviewlink) | A list of product links. Links are used to navigate from one product to another. | -| `queryType` - [`String`](types-q-s.md#string) | Indicates if the product was retrieved from the primary or the backup query | -| `visibility` - [`String`](types-q-s.md#string) | Visibility setting of the product | +| `metaDescription` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings. | +| `metaKeyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `metaTitle` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Product name. | +| `inputOptions` - [`[ProductViewInputOption]`](/reference/graphql/saas/types-k-p.md#productviewinputoption) | A list of input options. *(Deprecated: This field is deprecated and will be removed.)* | +| `options` - [`[ProductViewOption]`](/reference/graphql/saas/types-k-p.md#productviewoption) | A list of selectable options. | +| `priceRange` - [`ProductViewPriceRange`](/reference/graphql/saas/types-k-p.md#productviewpricerange) | A range of possible prices for a complex product. | +| `shortDescription` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A summary of the product. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A unique code used for identification of a product. | +| `externalId` - [`String`](/reference/graphql/saas/types-q-s.md#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | +| `url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | +| `urlKey` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL key of the product. | +| `links` - [`[ProductViewLink]`](/reference/graphql/saas/types-k-p.md#productviewlink) | A list of product links. Links are used to navigate from one product to another. | +| `queryType` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates if the product was retrieved from the primary or the backup query | +| `visibility` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Visibility setting of the product | #### Example ```json { - "addToCartAllowed": true, - "inStock": true, - "lowStock": true, + "addToCartAllowed": false, + "inStock": false, + "lowStock": false, "attributes": [ProductViewAttribute], - "description": "abc123", + "description": "xyz789", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], @@ -2641,17 +2641,17 @@ Represents all product types, except simple products. Complex product prices are "metaDescription": "xyz789", "metaKeyword": "xyz789", "metaTitle": "abc123", - "name": "xyz789", + "name": "abc123", "inputOptions": [ProductViewInputOption], "options": [ProductViewOption], "priceRange": ProductViewPriceRange, "shortDescription": "abc123", "sku": "abc123", "externalId": "xyz789", - "url": "xyz789", - "urlKey": "abc123", + "url": "abc123", + "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "abc123", + "queryType": "xyz789", "visibility": "xyz789" } ``` @@ -2664,7 +2664,7 @@ Represents all product types, except simple products. Complex product prices are | Field Name | Description | |------------|-------------| -| `html` - [`String!`](types-q-s.md#string) | Text that can contain HTML tags. | +| `html` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Text that can contain HTML tags. | #### Example @@ -2680,9 +2680,9 @@ Represents all product types, except simple products. Complex product prices are | Input Field | Description | |-------------|-------------| -| `field` - [`Field`](types-f-i.md#field) | | -| `operator` - [`OperatorInput`](types-k-p.md#operatorinput) | | -| `enabled` - [`Boolean`](types-a-b.md#boolean) | | +| `field` - [`Field`](/reference/graphql/saas/types-f-i.md#field) | | +| `operator` - [`OperatorInput`](/reference/graphql/saas/types-k-p.md#operatorinput) | | +| `enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | | #### Example @@ -2704,17 +2704,17 @@ Contains details about a configurable product attribute option. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The ID assigned to the attribute. | -| `label` - [`String`](types-q-s.md#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](types-f-i.md#int) | A unique index number assigned to the configurable product option. | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ID assigned to the attribute. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A unique index number assigned to the configurable product option. | #### Example ```json { "code": "xyz789", - "label": "xyz789", + "label": "abc123", "uid": "4", "value_index": 987 } @@ -2730,34 +2730,34 @@ An implementation for configurable product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](/reference/graphql/saas/types-q-s.md#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the cart item. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#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`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `is_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", + "backorder_message": "abc123", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "custom_attributes": [CustomAttribute], @@ -2766,17 +2766,17 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": true, + "is_available": false, "is_salable": false, - "max_qty": 987.65, + "max_qty": 123.45, "min_qty": 987.65, - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -2790,15 +2790,15 @@ Describes configurable options that have been selected and can be selected as a | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](types-f-i.md#id) | An array of selectable option value IDs. | +| `attribute_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of selectable option value IDs. | #### Example ```json { - "attribute_code": "xyz789", - "option_value_uids": [4] + "attribute_code": "abc123", + "option_value_uids": ["4"] } ``` @@ -2812,28 +2812,28 @@ Describes configurable options that have been selected and can be selected as a |------------|-------------| | `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`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](types-q-s.md#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/saas/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/saas/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the order item. | #### Example @@ -2853,16 +2853,16 @@ Describes configurable options that have been selected and can be selected as a "product_sale_price": Money, "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 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, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -2876,56 +2876,56 @@ Defines basic features of a configurable product and its simple product variants | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#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`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `country_of_manufacture` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/saas/types-k-p.md#productcustomattributes) | Product custom attributes. | | `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `gift_message_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `options_container` - [`String`](/reference/graphql/saas/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/saas/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The part of the URL that identifies the product | | `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, @@ -2934,23 +2934,23 @@ Defines basic features of a configurable product and its simple product variants "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "xyz789", - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "abc123", + "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, + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], @@ -2966,9 +2966,9 @@ Defines basic features of a configurable product and its simple product variants "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "variants": [ConfigurableVariant], - "weight": 987.65 + "weight": 123.45 } ``` @@ -2982,9 +2982,9 @@ Contains details about configurable product options. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the configurable option. | +| `attribute_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the configurable option. | | `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example @@ -2992,7 +2992,7 @@ Contains details about configurable product options. ```json { "attribute_code": "xyz789", - "label": "xyz789", + "label": "abc123", "uid": "4", "values": [ConfigurableProductOptionValue] } @@ -3008,11 +3008,11 @@ Defines a value for a configurable product option. | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of the value. | +| `is_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](/reference/graphql/saas/types-q-s.md#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the value. | #### Example @@ -3020,9 +3020,9 @@ Defines a value for a configurable product option. { "is_available": true, "is_use_default": true, - "label": "abc123", + "label": "xyz789", "swatch": SwatchDataInterface, - "uid": 4 + "uid": "4" } ``` @@ -3036,12 +3036,12 @@ Defines configurable attributes for the specified product. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | A string that identifies the attribute. | -| `attribute_uid` - [`ID!`](types-f-i.md#id) | The unique ID for an `Attribute` object. | -| `label` - [`String`](types-q-s.md#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is the default. | +| `attribute_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that identifies the attribute. | +| `attribute_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for an `Attribute` object. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number that indicates the order in which the attribute is displayed. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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 @@ -3050,10 +3050,10 @@ Defines configurable attributes for the specified product. { "attribute_code": "abc123", "attribute_uid": 4, - "label": "xyz789", + "label": "abc123", "position": 987, - "uid": 4, - "use_default": true, + "uid": "4", + "use_default": false, "values": [ConfigurableProductOptionsValues] } ``` @@ -3069,9 +3069,9 @@ Contains metadata corresponding to the selected configurable options. | Field Name | Description | |------------|-------------| | `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#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. | +| `variant` - [`SimpleProduct`](/reference/graphql/saas/types-q-s.md#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 @@ -3096,23 +3096,23 @@ Contains the index number assigned to a configurable product option. | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](types-q-s.md#string) | The label of the product on the default store. | -| `label` - [`String`](types-q-s.md#string) | The label of the product. | -| `store_label` - [`String`](types-q-s.md#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to use the default_label. | +| `default_label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product on the default store. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product. | +| `store_label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](/reference/graphql/saas/types-q-s.md#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether to use the default_label. | #### Example ```json { - "default_label": "xyz789", - "label": "abc123", - "store_label": "abc123", + "default_label": "abc123", + "label": "xyz789", + "store_label": "xyz789", "swatch_data": SwatchDataInterface, - "uid": 4, - "use_default_value": true + "uid": "4", + "use_default_value": false } ``` @@ -3126,12 +3126,12 @@ Contains details about configurable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | -| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](/reference/graphql/saas/types-q-s.md#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -3141,8 +3141,8 @@ Contains details about configurable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "sku": "xyz789", - "uid": "4" + "sku": "abc123", + "uid": 4 } ``` @@ -3157,7 +3157,7 @@ Contains all the simple product variants of a configurable product. | Field Name | Description | |------------|-------------| | `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](types-q-s.md#simpleproduct) | An array of linked simple products. | +| `product` - [`SimpleProduct`](/reference/graphql/saas/types-q-s.md#simpleproduct) | An array of linked simple products. | #### Example @@ -3178,27 +3178,27 @@ A configurable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `configurable_options` - [`[SelectedConfigurableOption]`](types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](/reference/graphql/saas/types-q-s.md#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this wish list item. | #### Example ```json { - "added_at": "abc123", + "added_at": "xyz789", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -3210,15 +3210,15 @@ A configurable product wish list item. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an `Order` type. | #### Example ```json { "confirmation_key": "abc123", - "order_id": "4" + "order_id": 4 } ``` @@ -3232,15 +3232,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | The key to confirm the email address. | -| `email` - [`String!`](types-q-s.md#string) | The email address to be confirmed. | +| `confirmation_key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The key to confirm the email address. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address to be confirmed. | #### Example ```json { - "confirmation_key": "xyz789", - "email": "abc123" + "confirmation_key": "abc123", + "email": "xyz789" } ``` @@ -3252,15 +3252,15 @@ Contains details about a customer email address to confirm. | Input Field | Description | |-------------|-------------| -| `confirmation_key` - [`String!`](types-q-s.md#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](types-f-i.md#id) | The unique ID of an `Order` type. | +| `confirmation_key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an `Order` type. | #### Example ```json { - "confirmation_key": "xyz789", - "order_id": 4 + "confirmation_key": "abc123", + "order_id": "4" } ``` @@ -3291,10 +3291,10 @@ List of account confirmation statuses. | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the shopper. | -| `name` - [`String!`](types-q-s.md#string) | The full name of the shopper. | -| `telephone` - [`String`](types-q-s.md#string) | The shopper's telephone number. | +| `comment` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address of the shopper. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The full name of the shopper. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The shopper's telephone number. | #### Example @@ -3317,7 +3317,7 @@ Contains the status of the request. | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request was successful. | +| `status` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the request was successful. | #### Example @@ -3335,7 +3335,7 @@ An input object that defines the items in a requisition list to be copied. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of IDs representing products copied from one requisition list to another. | #### Example @@ -3353,7 +3353,7 @@ Output of the request to copy items to the destination requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The destination requisition list after the items were copied. | #### Example @@ -3371,9 +3371,9 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/saas/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example @@ -3393,12 +3393,12 @@ Contains the source and target wish lists after copying products. | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](types-q-s.md#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](types-q-s.md#string) | The name of the country in English. | -| `full_name_locale` - [`String`](types-q-s.md#string) | The name of the country in the current locale. | -| `id` - [`String`](types-q-s.md#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | +| `available_regions` - [`[Region]`](/reference/graphql/saas/types-q-s.md#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the country in English. | +| `full_name_locale` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the country in the current locale. | +| `id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The two-letter abbreviation of the country, such as US. | #### Example @@ -3406,7 +3406,7 @@ Contains the source and target wish lists after copying products. { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "xyz789", + "full_name_locale": "abc123", "id": "abc123", "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" @@ -3757,12 +3757,12 @@ Contains an array of product IDs to use for creating a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](types-f-i.md#id) | An array of product IDs to add to the compare list. | +| `products` - [`[ID]`](/reference/graphql/saas/types-f-i.md#id) | An array of product IDs to add to the compare list. | #### Example ```json -{"products": [4]} +{"products": ["4"]} ``` @@ -3775,14 +3775,14 @@ Defines a new gift registry. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](types-q-s.md#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](types-f-i.md#id) | The ID of the selected event type. | -| `message` - [`String!`](types-q-s.md#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/saas/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the selected event type. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](/reference/graphql/saas/types-f-i.md#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](/reference/graphql/saas/types-a-b.md#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/saas/types-f-i.md#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](/reference/graphql/saas/types-f-i.md#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example @@ -3811,7 +3811,7 @@ Contains the results of a request to create a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The newly-created gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The newly-created gift registry. | #### Example @@ -3827,7 +3827,7 @@ Contains the results of a request to create a gift registry. | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](types-f-i.md#id) | Optional client-generated ID | +| `cart_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | Optional client-generated ID | #### Example @@ -3861,17 +3861,17 @@ Contains payment order details that are used while processing the payment order | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](types-q-s.md#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](types-k-p.md#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](types-q-s.md#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](types-q-s.md#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | +| `cartId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](/reference/graphql/saas/types-k-p.md#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the payment information should be vaulted | #### Example ```json { - "cartId": "abc123", + "cartId": "xyz789", "location": "PRODUCT_DETAIL", "methodCode": "abc123", "paymentSource": "abc123", @@ -3889,21 +3889,21 @@ Contains payment order details that are used while processing the payment order | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](types-f-i.md#float) | The amount of the payment order | -| `currency_code` - [`String`](types-q-s.md#string) | The currency of the payment order | -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `amount` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The amount of the payment order | +| `currency_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The currency of the payment order | +| `id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The order ID generated by Payment Services | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the payment order | #### Example ```json { - "amount": 123.45, - "currency_code": "abc123", - "id": "xyz789", - "mp_order_id": "xyz789", - "status": "abc123" + "amount": 987.65, + "currency_code": "xyz789", + "id": "abc123", + "mp_order_id": "abc123", + "status": "xyz789" } ``` @@ -3918,12 +3918,12 @@ Specifies the amount and currency to evaluate. | Input Field | Description | |-------------|-------------| | `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](types-f-i.md#float) | Purchase order approval rule condition amount value. | +| `value` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | Purchase order approval rule condition amount value. | #### Example ```json -{"currency": "AFN", "value": 987.65} +{"currency": "AFN", "value": 123.45} ``` @@ -3937,9 +3937,9 @@ Defines a set of conditions that apply to a rule. | 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!`](types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example @@ -3962,8 +3962,8 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | An optional description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The name assigned to the requisition list. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An optional description of the requisition list. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name assigned to the requisition list. | #### Example @@ -3984,7 +3984,7 @@ Output of the request to create a requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The created requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The created requisition list. | #### Example @@ -4002,15 +4002,15 @@ Describe the variables needed to create a vault payment token | Input Field | Description | |-------------|-------------| -| `card_description` - [`String`](types-q-s.md#string) | Description of the vaulted card | -| `setup_token_id` - [`String!`](types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | +| `card_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example ```json { - "card_description": "abc123", - "setup_token_id": "xyz789" + "card_description": "xyz789", + "setup_token_id": "abc123" } ``` @@ -4024,8 +4024,8 @@ The vault token id and information about the payment source | Field Name | Description | |------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](types-k-p.md#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](types-q-s.md#string) | The vault payment token information | +| `payment_source` - [`PaymentSourceOutput!`](/reference/graphql/saas/types-k-p.md#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The vault payment token information | #### Example @@ -4046,8 +4046,8 @@ Describe the variables needed to create a vault card setup token | Input Field | Description | |-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](types-t-z.md#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | The 3DS mode | +| `setup_token` - [`VaultSetupTokenInput!`](/reference/graphql/saas/types-t-z.md#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/saas/types-t-z.md#threedsmode) | The 3DS mode | #### Example @@ -4068,12 +4068,12 @@ The setup token id information | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](types-q-s.md#string) | The setup token id | +| `setup_token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The setup token id | #### Example ```json -{"setup_token": "xyz789"} +{"setup_token": "abc123"} ``` @@ -4086,8 +4086,8 @@ Defines the name and visibility of a new wish list. | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](/reference/graphql/saas/types-t-z.md#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -4105,7 +4105,7 @@ Contains the wish list. | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The newly-created wish list | +| `wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | The newly-created wish list | #### Example @@ -4123,11 +4123,11 @@ Contains credit memo details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the credit memo. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/saas/types-q-s.md#salescommentitem) | Comments on the credit memo. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemo` object. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CreditMemo` object. | | `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit memo number. | +| `number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The sequential credit memo number. | | `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example @@ -4136,9 +4136,9 @@ Contains credit memo details. { "comments": [SalesCommentItem], "custom_attributes": [CustomAttribute], - "id": "4", + "id": 4, "items": [CreditMemoItemInterface], - "number": "xyz789", + "number": "abc123", "total": CreditMemoTotal } ``` @@ -4153,7 +4153,7 @@ Defines a credit memo item's custom attributes. | Input Field | Description | |-------------|-------------| -| `credit_memo_id` - [`String!`](types-q-s.md#string) | The credit memo ID. | +| `credit_memo_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The credit memo ID. | | `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for the credit memo. | #### Example @@ -4175,12 +4175,12 @@ 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. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | #### Example @@ -4190,10 +4190,10 @@ Defines a credit memo item's custom attributes. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } ``` @@ -4207,16 +4207,16 @@ Defines a credit memo's custom attributes. | Input Field | Description | |-------------|-------------| -| `credit_memo_id` - [`String!`](types-q-s.md#string) | The credit memo ID. | -| `credit_memo_item_id` - [`String!`](types-q-s.md#string) | The credit memo item ID. | +| `credit_memo_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The credit memo ID. | +| `credit_memo_item_id` - [`String!`](/reference/graphql/saas/types-q-s.md#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": "xyz789", - "credit_memo_item_id": "xyz789", + "credit_memo_id": "abc123", + "credit_memo_item_id": "abc123", "custom_attributes": [CustomAttributeInput] } ``` @@ -4233,21 +4233,21 @@ Credit memo item details. |------------|-------------| | `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!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | #### Possible Types | CreditMemoItemInterface Types | |----------------| -| [`BundleCreditMemoItem`](types-a-b.md#bundlecreditmemoitem) | +| [`BundleCreditMemoItem`](/reference/graphql/saas/types-a-b.md#bundlecreditmemoitem) | | [`CreditMemoItem`](#creditmemoitem) | | [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`GiftCardCreditMemoItem`](types-f-i.md#giftcardcreditmemoitem) | +| [`GiftCardCreditMemoItem`](/reference/graphql/saas/types-f-i.md#giftcardcreditmemoitem) | #### Example @@ -4255,9 +4255,9 @@ Credit memo item details. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", "quantity_refunded": 123.45 @@ -4292,15 +4292,15 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](types-k-p.md#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | +| `adjustment` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The final base grand total amount in the base currency. | | `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the credit memo. | +| `grand_total` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/saas/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/saas/types-t-z.md#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The amount of tax applied to the credit memo. | #### Example @@ -4326,11 +4326,11 @@ Contains credit memo price details. | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](types-q-s.md#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](types-q-s.md#string) | The symbol for the specified base currency, such as $. | -| `default_display_currency_code` - [`String`](types-q-s.md#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](types-q-s.md#string) | The currency symbol that is displayed by default, such as $. | +| `available_currency_codes` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The symbol for the specified base currency, such as $. | +| `default_display_currency_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](/reference/graphql/saas/types-q-s.md#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 @@ -4339,8 +4339,8 @@ Contains credit memo price details. { "available_currency_codes": ["xyz789"], "base_currency_code": "abc123", - "base_currency_symbol": "abc123", - "default_display_currency_code": "xyz789", + "base_currency_symbol": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } @@ -4542,8 +4542,8 @@ Attributes of the product currently being viewed on PDP | Input Field | Description | |-------------|-------------| -| `sku` - [`String`](types-q-s.md#string) | SKU of the current product | -| `price` - [`Float`](types-f-i.md#float) | Resolved display price of the current product (specialPrice ?? regularPrice) | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | SKU of the current product | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Resolved display price of the current product (specialPrice ?? regularPrice) | #### Example @@ -4561,8 +4561,8 @@ Specifies the custom attribute code and value. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The custom attribute code. | -| `value` - [`String`](types-q-s.md#string) | The custom attribute code value. | +| `attribute_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The custom attribute code. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The custom attribute code value. | #### Example @@ -4583,15 +4583,15 @@ Defines a custom attribute. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | Attribute Code. | -| `value` - [`String!`](types-q-s.md#string) | Attribute Value. | +| `attribute_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Attribute Code. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Attribute Value. | #### Example ```json { "attribute_code": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -4605,24 +4605,24 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/saas/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/saas/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to the attribute. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | #### Possible Types | CustomAttributeMetadataInterface Types | |----------------| -| [`AttributeMetadata`](types-a-b.md#attributemetadata) | +| [`AttributeMetadata`](/reference/graphql/saas/types-a-b.md#attributemetadata) | | [`CatalogAttributeMetadata`](#catalogattributemetadata) | | [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](types-q-s.md#returnitemattributemetadata) | +| [`ReturnItemAttributeMetadata`](/reference/graphql/saas/types-q-s.md#returnitemattributemetadata) | #### Example @@ -4633,9 +4633,9 @@ An interface containing fields that define the EAV attribute. "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_required": true, + "is_required": false, "is_unique": true, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -4648,22 +4648,22 @@ An interface containing fields that define the EAV attribute. | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](types-a-b.md#boolean) | Is the option value default. | -| `label` - [`String!`](types-q-s.md#string) | The label assigned to the attribute option. | -| `value` - [`String!`](types-q-s.md#string) | The attribute option value. | +| `is_default` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Is the option value default. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to the attribute option. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute option value. | #### Possible Types | CustomAttributeOptionInterface Types | |----------------| -| [`AttributeOptionMetadata`](types-a-b.md#attributeoptionmetadata) | +| [`AttributeOptionMetadata`](/reference/graphql/saas/types-a-b.md#attributeoptionmetadata) | #### Example ```json { "is_default": true, - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -4678,8 +4678,8 @@ A simple key value object. | Field Name | Description | |------------|-------------| -| `key` - [`String`](types-q-s.md#string) | | -| `value` - [`String`](types-q-s.md#string) | | +| `key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -4699,14 +4699,14 @@ A simple key value object. | Input Field | Description | |-------------|-------------| | `type` - [`CustomOperatorType`](#customoperatortype) | | -| `value` - [`[String]`](types-q-s.md#string) | | +| `value` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | | #### Example ```json { "type": "UNKNOWN_CUSTOMOPERATOR_TYPE", - "value": ["abc123"] + "value": ["xyz789"] } ``` @@ -4739,52 +4739,52 @@ Defines the customer name, addresses, and other details. |------------|-------------| | `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!`](types-a-b.md#adminassistanceactions) | Actions performed by an admin on behalf of the customer (Login as Customer logging). | -| `allow_remote_shopping_assistance` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](types-t-z.md#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `admin_assistance_actions` - [`AdminAssistanceActions!`](/reference/graphql/saas/types-a-b.md#adminassistanceactions) | Actions performed by an admin on behalf of the customer (Login as Customer logging). | +| `allow_remote_shopping_assistance` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](/reference/graphql/saas/types-t-z.md#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`](types-q-s.md#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `default_billing` - [`String`](types-q-s.md#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](types-q-s.md#string) | The ID assigned to the shipping address. | -| `email` - [`String`](types-q-s.md#string) | The customer's email address. Required. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | Details about a specific gift registry. | +| `created_at` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's date of birth. | +| `default_billing` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ID assigned to the shipping address. | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's email address. Required. | +| `firstname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](/reference/graphql/saas/types-f-i.md#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | Details about a specific gift registry. | | `group` - [`CustomerGroupStorefront`](#customergroupstorefront) | Customer group assigned to the customer | -| `id` - [`ID!`](types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](types-q-s.md#string) | The job title of a company user. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The job title of a company user. | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's middle name. | | `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](types-k-p.md#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](types-q-s.md#returns) | Information about the customer's return requests. | -| `reward_points` - [`RewardPoints`](types-q-s.md#rewardpoints) | Customer reward points details. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](/reference/graphql/saas/types-k-p.md#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](/reference/graphql/saas/types-k-p.md#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-q-s.md#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](/reference/graphql/saas/types-q-s.md#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](/reference/graphql/saas/types-q-s.md#returns) | Information about the customer's return requests. | +| `reward_points` - [`RewardPoints`](/reference/graphql/saas/types-q-s.md#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!`](types-f-i.md#id) | ID of the company structure | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `structure_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | ID of the company structure | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The phone number of the company user. | -| `wishlist_v2` - [`Wishlist`](types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#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. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The phone number of the company user. | +| `wishlist_v2` - [`Wishlist`](/reference/graphql/saas/types-t-z.md#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/saas/types-t-z.md#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 @@ -4793,27 +4793,27 @@ Defines the customer name, addresses, and other details. "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": true, + "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": "xyz789", + "date_of_birth": "abc123", "default_billing": "xyz789", - "default_shipping": "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": "xyz789", + "id": 4, + "is_subscribed": false, + "job_title": "abc123", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -4822,7 +4822,7 @@ Defines the customer name, addresses, and other details. "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, "purchase_orders_enabled": true, - "quote_enabled": true, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -4831,7 +4831,7 @@ Defines the customer name, addresses, and other details. "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, + "structure_id": "4", "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, @@ -4851,27 +4851,27 @@ Contains detailed information about a customer's billing or shipping address. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's company. | | `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the customer's default shipping address. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](types-f-i.md#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-f-i.md#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CustomerAddress` object. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomerAddress` object. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example @@ -4882,22 +4882,22 @@ Contains detailed information about a customer's billing or shipping address. "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "xyz789", - "id": 987, - "lastname": "abc123", + "firstname": "abc123", + "id": 123, + "lastname": "xyz789", "middlename": "abc123", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], "suffix": "xyz789", - "telephone": "abc123", + "telephone": "xyz789", "uid": "4", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -4911,14 +4911,14 @@ Specifies the attribute code and value of a customer address attribute. | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](types-q-s.md#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](types-q-s.md#string) | The value assigned to the customer address attribute. | +| `attribute_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value assigned to the customer address attribute. | #### Example ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "abc123" } ``` @@ -4933,23 +4933,23 @@ Contains details about a billing or shipping address. | Input Field | Description | |-------------|-------------| -| `city` - [`String`](types-q-s.md#string) | The customer's city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | +| `city` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's city or town. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's company. | | `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `custom_attributesV2` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](types-q-s.md#string) | The customer's fax number. | -| `firstname` - [`String`](types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributesV2` - [`[AttributeValueInput]`](/reference/graphql/saas/types-a-b.md#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's fax number. | +| `firstname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `street` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's telephone number. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -4960,18 +4960,18 @@ Contains details about a billing or shipping address. "country_code": "AF", "custom_attributesV2": [AttributeValueInput], "default_billing": true, - "default_shipping": true, + "default_shipping": false, "fax": "xyz789", "firstname": "xyz789", - "lastname": "abc123", - "middlename": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegionInput, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "abc123", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -4985,17 +4985,17 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "abc123", - "region_code": "abc123", - "region_id": 123 + "region": "xyz789", + "region_code": "xyz789", + "region_id": 987 } ``` @@ -5009,17 +5009,17 @@ Defines the customer's state or province. | Input Field | Description | |-------------|-------------| -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_code` - [`String`](types-q-s.md#string) | The address region code. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `region` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The state or province name. | +| `region_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The address region code. | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "region": "abc123", - "region_code": "xyz789", - "region_id": 987 + "region": "xyz789", + "region_code": "abc123", + "region_id": 123 } ``` @@ -5032,8 +5032,8 @@ Defines the customer's state or province. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer addresses. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The total count of customer addresses. | #### Example @@ -5041,7 +5041,7 @@ Defines the customer's state or province. { "items": [CustomerAddress], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5055,36 +5055,36 @@ Customer attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](types-q-s.md#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](types-q-s.md#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](types-q-s.md#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/saas/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/saas/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/saas/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The number of lines of the attribute value. | | `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/saas/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": "4", - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, - "is_unique": false, - "label": "xyz789", + "is_required": false, + "is_unique": true, + "label": "abc123", "multiline_count": 987, "options": [CustomAttributeOptionInterface], - "sort_order": 987, + "sort_order": 123, "validate_rules": [ValidationRule] } ``` @@ -5099,36 +5099,36 @@ An input object for creating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `email` - [`String!`](types-q-s.md#string) | The customer's email address. | -| `firstname` - [`String!`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `password` - [`String`](types-q-s.md#string) | The customer's password. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/saas/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's date of birth. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's email address. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's middle name. | +| `password` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's password. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", "email": "xyz789", "firstname": "abc123", "gender": 987, "is_subscribed": false, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "password": "abc123", "prefix": "xyz789", - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "abc123" } ``` @@ -5143,20 +5143,20 @@ Contains details about a single downloadable product. | Field Name | Description | |------------|-------------| -| `date` - [`String`](types-q-s.md#string) | The date and time the purchase was made. | -| `download_url` - [`String`](types-q-s.md#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](types-q-s.md#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](types-q-s.md#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | +| `date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The date and time the purchase was made. | +| `download_url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "date": "xyz789", + "date": "abc123", "download_url": "abc123", - "order_increment_id": "abc123", - "remaining_downloads": "abc123", + "order_increment_id": "xyz789", + "remaining_downloads": "xyz789", "status": "xyz789" } ``` @@ -5189,12 +5189,12 @@ Data of customer group. | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerGroup` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomerGroup` object. | #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -5207,38 +5207,38 @@ Contains details about each of the customer's orders. | Field Name | Description | |------------|-------------| -| `admin_assisted_order` - [`Int`](types-f-i.md#int) | Admin user id when the order was placed with assistance (Login as Customer); null if not assisted. | -| `applied_coupons` - [`[AppliedCoupon]!`](types-a-b.md#appliedcoupon) | Coupons applied to the order. | -| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | -| `available_actions` - [`[OrderActionType]!`](types-k-p.md#orderactiontype) | List of available order actions. | -| `billing_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](types-q-s.md#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments about the order. | +| `admin_assisted_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Admin user id when the order was placed with assistance (Login as Customer); null if not assisted. | +| `applied_coupons` - [`[AppliedCoupon]!`](/reference/graphql/saas/types-a-b.md#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](/reference/graphql/saas/types-a-b.md#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](/reference/graphql/saas/types-k-p.md#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](/reference/graphql/saas/types-k-p.md#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/saas/types-q-s.md#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!`](types-k-p.md#ordercustomerinfo) | Returns customer information from order. | -| `email` - [`String`](types-q-s.md#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | -| `invoices` - [`[Invoice]!`](types-f-i.md#invoice) | A list of invoices for the order. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | `TRUE` if the order is virtual | -| `items` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | -| `negotiable_quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote associated with this order. | -| `number` - [`String!`](types-q-s.md#string) | The order number. | -| `order_date` - [`String!`](types-q-s.md#string) | The date the order was placed. | -| `order_status_change_date` - [`String!`](types-q-s.md#string) | The date the order status was last updated. | -| `payment_methods` - [`[OrderPaymentMethod]`](types-k-p.md#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](types-q-s.md#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](types-k-p.md#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](types-k-p.md#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](types-q-s.md#string) | The delivery method for the order. | -| `status` - [`String!`](types-q-s.md#string) | The current status of the order. | -| `token` - [`String!`](types-q-s.md#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](types-k-p.md#ordertotal) | Details about the calculated totals for this order. | +| `customer_info` - [`OrderCustomerInfo!`](/reference/graphql/saas/types-k-p.md#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the order. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomerOrder` object. | +| `invoices` - [`[Invoice]!`](/reference/graphql/saas/types-f-i.md#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | A list of order items eligible to be in a return request. | +| `negotiable_quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote associated with this order. | +| `number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The order number. | +| `order_date` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the order was placed. | +| `order_status_change_date` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](/reference/graphql/saas/types-k-p.md#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](/reference/graphql/saas/types-q-s.md#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](/reference/graphql/saas/types-k-p.md#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](/reference/graphql/saas/types-k-p.md#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The delivery method for the order. | +| `status` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The current status of the order. | +| `token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](/reference/graphql/saas/types-k-p.md#ordertotal) | Details about the calculated totals for this order. | #### Example @@ -5249,7 +5249,7 @@ Contains details about each of the customer's orders. "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], @@ -5260,21 +5260,21 @@ Contains details about each of the customer's orders. "gift_wrapping": GiftWrapping, "id": 4, "invoices": [Invoice], - "is_virtual": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "xyz789", + "number": "abc123", "order_date": "abc123", - "order_status_change_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "xyz789", - "token": "abc123", + "shipping_method": "abc123", + "status": "abc123", + "token": "xyz789", "total": OrderTotal } ``` @@ -5289,7 +5289,7 @@ CustomerOrderSortInput specifies the field to use for sorting search results and | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_direction` - [`SortEnum!`](/reference/graphql/saas/types-q-s.md#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 @@ -5327,19 +5327,19 @@ The collection of orders that match the conditions defined in the filter. | Field Name | Description | |------------|-------------| -| `date_of_first_order` - [`String`](types-q-s.md#string) | Date of the first order placed in the store | +| `date_of_first_order` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Date of the first order placed in the store | | `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total count of customer orders. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The total count of customer orders. | #### Example ```json { - "date_of_first_order": "abc123", + "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5353,10 +5353,10 @@ Identifies the filter to use for filtering orders. | Input Field | Description | |-------------|-------------| -| `grand_total` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | -| `number` - [`FilterStringTypeInput`](types-f-i.md#filterstringtypeinput) | Filters by order number. | -| `order_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | -| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filters by order status. | +| `grand_total` - [`FilterRangeTypeInput`](/reference/graphql/saas/types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](/reference/graphql/saas/types-f-i.md#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](/reference/graphql/saas/types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filters by order status. | #### Example @@ -5397,7 +5397,7 @@ Contains payment tokens stored in the customer's vault. | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](types-k-p.md#paymenttoken) | An array of payment tokens. | +| `items` - [`[PaymentToken]!`](/reference/graphql/saas/types-k-p.md#paymenttoken) | An array of payment tokens. | #### Example @@ -5415,7 +5415,7 @@ Customer segment details | Field Name | Description | |------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomerSegment` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomerSegment` object. | #### Example @@ -5434,8 +5434,8 @@ Contains store credit information with balance and history. | 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`](types-k-p.md#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | +| `current_balance` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example @@ -5458,8 +5458,8 @@ Lists changes to the amount of store credit available to the customer. | Field Name | Description | |------------|-------------| | `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of items returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The number of items returned. | #### Example @@ -5467,7 +5467,7 @@ Lists changes to the amount of store credit available to the customer. { "items": [CustomerStoreCreditHistoryItem], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5481,16 +5481,16 @@ Contains store credit history information. | Field Name | Description | |------------|-------------| -| `action` - [`String`](types-q-s.md#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](types-k-p.md#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](types-q-s.md#string) | The date and time when the store credit change was made. | +| `action` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The date and time when the store credit change was made. | #### Example ```json { - "action": "abc123", + "action": "xyz789", "actual_balance": Money, "balance_change": Money, "date_time_changed": "xyz789" @@ -5507,7 +5507,7 @@ Contains a customer authorization token. | Field Name | Description | |------------|-------------| -| `token` - [`String`](types-q-s.md#string) | The customer authorization token. | +| `token` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer authorization token. | #### Example @@ -5525,31 +5525,31 @@ An input object for updating a customer. | Input Field | Description | |-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](types-q-s.md#string) | The customer's date of birth. | -| `firstname` - [`String`](types-q-s.md#string) | The customer's first name. | -| `gender` - [`Int`](types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](types-q-s.md#string) | The customer's family name. | -| `middlename` - [`String`](types-q-s.md#string) | The customer's middle name. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `allow_remote_shopping_assistance` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/saas/types-a-b.md#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's date of birth. | +| `firstname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's first name. | +| `gender` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's family name. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's middle name. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], "date_of_birth": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "gender": 987, - "is_subscribed": false, + "is_subscribed": true, "lastname": "abc123", "middlename": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "suffix": "xyz789", "taxvat": "abc123" } @@ -5565,20 +5565,20 @@ Contains information about a text area that is defined as part of a customizable | Field Name | Description | |------------|-------------| -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `product_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "product_sku": "xyz789", - "required": true, - "sort_order": 123, + "product_sku": "abc123", + "required": false, + "sort_order": 987, "title": "xyz789", "uid": 4, "value": CustomizableAreaValue @@ -5595,11 +5595,11 @@ Defines the price and sku of a product whose page contains a customized text are | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | +| `max_characters` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example @@ -5609,7 +5609,7 @@ Defines the price and sku of a product whose page contains a customized text are "price": 123.45, "price_type": "FIXED", "sku": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5623,17 +5623,17 @@ Contains information about a set of checkbox values that are defined as part of | Field Name | Description | |------------|-------------| -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example ```json { - "required": false, + "required": true, "sort_order": 987, "title": "xyz789", "uid": 4, @@ -5651,25 +5651,25 @@ Defines the price and sku of a product whose page contains a customized set of c | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "option_type_id": 123, + "option_type_id": 987, "price": 123.45, "price_type": "FIXED", "sku": "abc123", "sort_order": 123, - "title": "xyz789", - "uid": "4" + "title": "abc123", + "uid": 4 } ``` @@ -5683,19 +5683,19 @@ Contains information about a date picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `product_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#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, + "product_sku": "abc123", + "required": false, "sort_order": 987, "title": "abc123", "uid": "4", @@ -5733,11 +5733,11 @@ Defines the price and sku of a product whose page contains a customized date pic | Field Name | Description | |------------|-------------| -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | | `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableDateValue` object. | #### Example @@ -5745,7 +5745,7 @@ Defines the price and sku of a product whose page contains a customized date pic { "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "type": "DATE", "uid": "4" } @@ -5761,19 +5761,19 @@ Contains information about a drop down menu that is defined as part of a customi | Field Name | Description | |------------|-------------| -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#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, + "required": true, "sort_order": 987, - "title": "abc123", + "title": "xyz789", "uid": 4, "value": [CustomizableDropDownValue] } @@ -5789,25 +5789,25 @@ Defines the price and sku of a product whose page contains a customized drop dow | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "option_type_id": 123, - "price": 123.45, + "option_type_id": 987, + "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "sort_order": 987, - "title": "abc123", - "uid": "4" + "title": "xyz789", + "uid": 4 } ``` @@ -5821,22 +5821,22 @@ Contains information about a text field that is defined as part of a customizabl | Field Name | Description | |------------|-------------| -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `product_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "product_sku": "abc123", - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": "4", + "product_sku": "xyz789", + "required": false, + "sort_order": 123, + "title": "xyz789", + "uid": 4, "value": CustomizableFieldValue } ``` @@ -5851,11 +5851,11 @@ Defines the price and sku of a product whose page contains a customized text fie | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](types-f-i.md#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | +| `max_characters` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example @@ -5864,7 +5864,7 @@ Defines the price and sku of a product whose page contains a customized text fie "max_characters": 123, "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "uid": "4" } ``` @@ -5879,11 +5879,11 @@ Contains information about a file picker that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `product_sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `product_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example @@ -5894,7 +5894,7 @@ Contains information about a file picker that is defined as part of a customizab "required": true, "sort_order": 123, "title": "xyz789", - "uid": "4", + "uid": 4, "value": CustomizableFileValue } ``` @@ -5909,25 +5909,25 @@ Defines the price and sku of a product whose page contains a customized file pic | Field Name | Description | |------------|-------------| -| `file_extension` - [`String`](types-q-s.md#string) | The file extension to accept. | -| `image_size_x` - [`Int`](types-f-i.md#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](types-f-i.md#int) | The maximum height of an image. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | +| `file_extension` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file extension to accept. | +| `image_size_x` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum height of an image. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { "file_extension": "xyz789", - "image_size_x": 123, + "image_size_x": 987, "image_size_y": 987, "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -5941,19 +5941,19 @@ Contains information about a multiselect that is defined as part of a customizab | Field Name | Description | |------------|-------------| -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#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": "xyz789", + "required": false, + "sort_order": 987, + "title": "abc123", "uid": "4", "value": [CustomizableMultipleValue] } @@ -5969,22 +5969,22 @@ Defines the price and sku of a product whose page contains a customized multisel | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { "option_type_id": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 987, "title": "abc123", "uid": 4 @@ -6001,13 +6001,13 @@ Defines a customizable option. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](types-q-s.md#string) | The string value of the option. | +| `uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The string value of the option. | #### Example ```json -{"uid": 4, "value_string": "abc123"} +{"uid": 4, "value_string": "xyz789"} ``` @@ -6020,10 +6020,10 @@ Contains basic information about a customizable option. It can be implemented by | Field Name | Description | |------------|-------------| -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | #### Possible Types @@ -6042,9 +6042,9 @@ Contains basic information about a customizable option. It can be implemented by ```json { - "required": false, + "required": true, "sort_order": 987, - "title": "xyz789", + "title": "abc123", "uid": "4" } ``` @@ -6065,12 +6065,12 @@ Contains information about customizable product options. | CustomizableProductInterface Types | |----------------| -| [`BundleProduct`](types-a-b.md#bundleproduct) | +| [`BundleProduct`](/reference/graphql/saas/types-a-b.md#bundleproduct) | | [`ConfigurableProduct`](#configurableproduct) | | [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`GiftCardProduct`](/reference/graphql/saas/types-f-i.md#giftcardproduct) | +| [`SimpleProduct`](/reference/graphql/saas/types-q-s.md#simpleproduct) | +| [`VirtualProduct`](/reference/graphql/saas/types-t-z.md#virtualproduct) | #### Example @@ -6088,10 +6088,10 @@ Contains information about a set of radio buttons that are defined as part of a | Field Name | Description | |------------|-------------| -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the option is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the option is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object. | | `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example @@ -6100,7 +6100,7 @@ Contains information about a set of radio buttons that are defined as part of a { "required": true, "sort_order": 987, - "title": "abc123", + "title": "xyz789", "uid": 4, "value": [CustomizableRadioValue] } @@ -6116,23 +6116,23 @@ Defines the price and sku of a product whose page contains a customized set of r | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](types-f-i.md#int) | The ID assigned to the value. | -| `price` - [`Float`](types-f-i.md#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](types-q-s.md#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](types-f-i.md#int) | The order in which the radio button is displayed. | -| `title` - [`String`](types-q-s.md#string) | The display name for this option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | +| `option_type_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The ID assigned to the value. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](/reference/graphql/saas/types-k-p.md#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The order in which the radio button is displayed. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name for this option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { "option_type_id": 987, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, + "sku": "xyz789", + "sort_order": 123, "title": "abc123", "uid": 4 } @@ -6160,7 +6160,7 @@ Contains the response to the request to delete the company role. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | +| `success` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example @@ -6178,7 +6178,7 @@ Contains the status of the request to delete a company team. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | +| `success` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the delete operation succeeded. | #### Example @@ -6196,7 +6196,7 @@ Contains the response to the request to delete the company user. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | +| `success` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example @@ -6214,7 +6214,7 @@ Contains the results of the request to delete a compare list. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | +| `result` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the compare list was successfully deleted. | #### Example @@ -6230,9 +6230,9 @@ Contains the results of the request to delete a compare list. | Union Types | |-------------| -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | -| [`InternalError`](types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/saas/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/saas/types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/saas/types-f-i.md#internalerror) | #### Example @@ -6251,7 +6251,7 @@ Contains details about a failed delete operation on a negotiable quote. | Field Name | Description | |------------|-------------| | `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -6270,7 +6270,7 @@ Contains details about a failed delete operation on a negotiable quote. | Union Types | |-------------| -| [`NegotiableQuoteUidOperationSuccess`](types-k-p.md#negotiablequoteuidoperationsuccess) | +| [`NegotiableQuoteUidOperationSuccess`](/reference/graphql/saas/types-k-p.md#negotiablequoteuidoperationsuccess) | | [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example @@ -6289,7 +6289,7 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -6305,12 +6305,12 @@ Specifies the quote template id of the quote template to delete | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | +| `quote_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -6323,9 +6323,9 @@ Contains a list of undeleted negotiable quotes the company user can view. | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](types-k-p.md#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](/reference/graphql/saas/types-k-p.md#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!`](types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | +| `result_status` - [`BatchMutationStatus!`](/reference/graphql/saas/types-a-b.md#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example @@ -6350,7 +6350,7 @@ Indicates whether the request succeeded and returns the remaining customer payme | Field Name | Description | |------------|-------------| | `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request succeeded. | +| `result` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the request succeeded. | #### Example @@ -6371,13 +6371,13 @@ Contains details about an error that occurred when deleting an approval rule . | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The text of the error message. | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The text of the error message. | | `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"message": "xyz789", "type": "UNDEFINED"} +{"message": "abc123", "type": "UNDEFINED"} ``` @@ -6407,7 +6407,7 @@ Specifies the IDs of the approval rules to delete. | Input Field | Description | |-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order approval rule IDs. | +| `approval_rule_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of purchase order approval rule IDs. | #### Example @@ -6443,7 +6443,7 @@ Output of the request to remove items from the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after removing items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The requisition list after removing items. | #### Example @@ -6461,8 +6461,8 @@ Indicates whether the request to delete the requisition list was successful. | Field Name | Description | |------------|-------------| -| `requisition_lists` - [`RequisitionLists`](types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | +| `requisition_lists` - [`RequisitionLists`](/reference/graphql/saas/types-q-s.md#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example @@ -6480,8 +6480,8 @@ Contains the status of the request to delete a wish list and an array of the cus | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](types-t-z.md#wishlist) | A list of undeleted wish lists. | +| `status` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](/reference/graphql/saas/types-t-z.md#wishlist) | A list of undeleted wish lists. | #### Example @@ -6499,13 +6499,13 @@ Specifies the discount type and value for quote line item. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The amount of the discount. | | `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](types-a-b.md#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](types-a-b.md#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](types-q-s.md#string) | A description of the discount. | -| `type` - [`String`](types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](types-f-i.md#float) | Quote line item discount value. | +| `coupon` - [`AppliedCoupon`](/reference/graphql/saas/types-a-b.md#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A description of the discount. | +| `type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quote line item discount value. | #### Example @@ -6515,9 +6515,9 @@ Specifies the discount type and value for quote line item. "applied_to": "ITEM", "coupon": AppliedCoupon, "is_discounting_locked": true, - "label": "abc123", - "type": "xyz789", - "value": 123.45 + "label": "xyz789", + "type": "abc123", + "value": 987.65 } ``` @@ -6531,30 +6531,30 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| -| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `backorder_message` - [`String`](/reference/graphql/saas/types-q-s.md#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]!`](types-q-s.md#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#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!`](types-a-b.md#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!`](types-a-b.md#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. | +| `is_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | +| `max_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#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!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#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!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "backorder_message": "abc123", + "backorder_message": "xyz789", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], @@ -6562,16 +6562,16 @@ An implementation for downloadable product cart items. "is_available": false, "is_salable": true, "links": [DownloadableProductLinks], - "max_qty": 123.45, - "min_qty": 123.45, + "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, + "quantity": 123.45, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -6588,12 +6588,12 @@ Defines downloadable product options for `CreditMemoItemInterface`. | `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!`](types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | #### Example @@ -6604,9 +6604,9 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": "4", "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 123.45 } ``` @@ -6624,12 +6624,12 @@ Defines downloadable product options for `InvoiceItemInterface`. | `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!`](types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of invoiced items. | #### Example @@ -6657,9 +6657,9 @@ Defines characteristics of the links for downloadable product. | Field Name | Description | |------------|-------------| -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example @@ -6684,27 +6684,27 @@ Defines downloadable product options for `OrderItemInterface`. | `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`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](/reference/graphql/saas/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/saas/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the order item. | #### Example @@ -6713,24 +6713,24 @@ Defines downloadable product options for `OrderItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "xyz789", "quantity_canceled": 987.65, "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, "quantity_return_requested": 123.45, - "quantity_returned": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" @@ -6747,50 +6747,50 @@ Defines a product that the shopper downloads. | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#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`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | +| `country_of_manufacture` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/saas/types-k-p.md#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!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](types-q-s.md#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | +| `gift_message_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `options_container` - [`String`](/reference/graphql/saas/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/saas/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The part of the URL that identifies the product | #### Example @@ -6798,7 +6798,7 @@ Defines a product that the shopper downloads. { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -6808,19 +6808,19 @@ Defines a product that the shopper downloads. "downloadable_product_samples": [ DownloadableProductSamples ], - "gift_message_available": true, - "gift_wrapping_available": true, + "gift_message_available": false, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "links_purchased_separately": 123, - "links_title": "xyz789", + "links_title": "abc123", "manufacturer": 987, - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 123.45, "name": "xyz789", "new_from_date": "abc123", @@ -6831,17 +6831,17 @@ Defines a product that the shopper downloads. "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], "url_key": "abc123" } @@ -6883,18 +6883,18 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `price` - [`Float`](types-f-i.md#float) | The price of the downloadable product. | -| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the link. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | +| `price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The price of the downloadable product. | +| `sample_url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the link. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { - "price": 123.45, - "sample_url": "xyz789", + "price": 987.65, + "sample_url": "abc123", "sort_order": 123, "title": "abc123", "uid": 4 @@ -6911,7 +6911,7 @@ Contains the link ID for the downloadable product. | Input Field | Description | |-------------|-------------| -| `link_id` - [`Int!`](types-f-i.md#int) | The unique ID of the downloadable product link. | +| `link_id` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The unique ID of the downloadable product link. | #### Example @@ -6929,9 +6929,9 @@ Defines characteristics of a downloadable product. | Field Name | Description | |------------|-------------| -| `sample_url` - [`String`](types-q-s.md#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](types-f-i.md#int) | A number indicating the sort order. | -| `title` - [`String`](types-q-s.md#string) | The display name of the sample. | +| `sample_url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number indicating the sort order. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the sample. | #### Example @@ -6939,7 +6939,7 @@ Defines characteristics of a downloadable product. { "sample_url": "abc123", "sort_order": 987, - "title": "xyz789" + "title": "abc123" } ``` @@ -6953,13 +6953,13 @@ Contains details about downloadable products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the product added to the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of the product added to the requisition list. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of an item in a requisition list. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of an item in a requisition list. | #### Example @@ -6968,7 +6968,7 @@ Contains details about downloadable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "links": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples], "sku": "xyz789", "uid": "4" @@ -6985,26 +6985,26 @@ A downloadable product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `added_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | | `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this wish list item. | | `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "id": "4", "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples] } ``` @@ -7019,16 +7019,13 @@ Identifies a quote to be duplicated | Input Field | Description | |-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](types-f-i.md#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | ID of the quote to be duplicated. | +| `duplicated_quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | ID of the quote to be duplicated. | #### Example ```json -{ - "duplicated_quote_uid": "4", - "quote_uid": 4 -} +{"duplicated_quote_uid": 4, "quote_uid": 4} ``` @@ -7041,7 +7038,7 @@ Contains the newly created negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example @@ -7059,14 +7056,14 @@ Contains details about a custom text attribute that the buyer entered. | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](types-q-s.md#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](types-q-s.md#string) | The text or other entered value. | +| `attribute_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The text or other entered value. | #### Example ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "abc123" } ``` @@ -7081,8 +7078,8 @@ Defines a customer-entered option. | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](types-q-s.md#string) | Text the customer entered. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Text the customer entered. | #### Example @@ -7101,21 +7098,21 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| | `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | #### Possible Types | Error Types | |----------------| | [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](types-f-i.md#insufficientstockerror) | +| [`InsufficientStockError`](/reference/graphql/saas/types-f-i.md#insufficientstockerror) | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -7127,15 +7124,15 @@ An error encountered while adding an item to the the cart. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The returned error message. | #### Possible Types | ErrorInterface Types | |----------------| -| [`InternalError`](types-f-i.md#internalerror) | -| [`NegotiableQuoteInvalidStateError`](types-k-p.md#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](types-k-p.md#nosuchentityuiderror) | +| [`InternalError`](/reference/graphql/saas/types-f-i.md#internalerror) | +| [`NegotiableQuoteInvalidStateError`](/reference/graphql/saas/types-k-p.md#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](/reference/graphql/saas/types-k-p.md#nosuchentityuiderror) | #### Example @@ -7154,7 +7151,7 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's ZIP or postal code. | | `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example @@ -7162,7 +7159,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput } ``` @@ -7176,8 +7173,8 @@ Contains details about an address. | Input Field | Description | |-------------|-------------| | `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](/reference/graphql/saas/types-q-s.md#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example @@ -7236,14 +7233,14 @@ Contains customer token for external customer. | Field Name | Description | |------------|-------------| | `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | -| `token` - [`String!`](types-q-s.md#string) | The customer authorization token. | +| `token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The customer authorization token. | #### Example ```json { "customer": Customer, - "token": "abc123" + "token": "xyz789" } ``` @@ -7257,13 +7254,13 @@ Lists the exchange rate. | Field Name | Description | |------------|-------------| -| `currency_to` - [`String`](types-q-s.md#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](types-f-i.md#float) | The exchange rate for the store’s default currency. | +| `currency_to` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The exchange rate for the store’s default currency. | #### Example ```json -{"currency_to": "xyz789", "rate": 123.45} +{"currency_to": "xyz789", "rate": 987.65} ``` 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 index 734d93c34..fbbef4e4a 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md @@ -6,14 +6,14 @@ | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/saas/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/saas/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -22,11 +22,11 @@ "code": "xyz789", "is_visible": true, "payment_intent": "abc123", - "payment_source": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", - "title": "abc123" + "title": "xyz789" } ``` @@ -40,8 +40,8 @@ Fastlane Payment inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `paypal_fastlane_token` - [`String`](types-q-s.md#string) | The single use token from Fastlane | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `paypal_fastlane_token` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The single use token from Fastlane | #### Example @@ -85,15 +85,15 @@ Defines a filter that matches the input exactly. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#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]`](types-q-s.md#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"]`. | +| `eq` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](/reference/graphql/saas/types-q-s.md#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"] + "eq": "abc123", + "in": ["xyz789"] } ``` @@ -124,13 +124,13 @@ Defines a filter that performs a fuzzy search. | Input Field | Description | |-------------|-------------| -| `match` - [`String`](types-q-s.md#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` - [`String`](/reference/graphql/saas/types-q-s.md#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"} +{"match": "xyz789", "match_type": "FULL"} ``` @@ -143,8 +143,8 @@ Defines a filter that matches a range of values, such as prices or dates. | Input Field | Description | |-------------|-------------| -| `from` - [`String`](types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | +| `from` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Use this attribute to specify the highest possible value in the range. | #### Example @@ -163,9 +163,9 @@ Defines a filter that matches a range of values, such as prices or dates. | Input Field | Description | |-------------|-------------| -| `name` - [`String`](types-q-s.md#string) | | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | | `type` - [`FilterRuleType`](#filterruletype) | | -| `conditions` - [`[ConditionInput]`](types-c-e.md#conditioninput) | | +| `conditions` - [`[ConditionInput]`](/reference/graphql/saas/types-c-e.md#conditioninput) | | #### Example @@ -205,9 +205,9 @@ Defines a filter for an input string. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | +| `eq` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Defines a filter that performs a fuzzy search using the specified string. | #### Example @@ -215,7 +215,7 @@ Defines a filter for an input string. { "eq": "xyz789", "in": ["abc123"], - "match": "abc123" + "match": "xyz789" } ``` @@ -229,20 +229,20 @@ Defines the comparison operators that can be used in a filter. | Input Field | Description | |-------------|-------------| -| `eq` - [`String`](types-q-s.md#string) | Equals. | -| `from` - [`String`](types-q-s.md#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](types-q-s.md#string) | Greater than. | -| `gteq` - [`String`](types-q-s.md#string) | Greater than or equal to. | -| `in` - [`[String]`](types-q-s.md#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](types-q-s.md#string) | Less than. | -| `lteq` - [`String`](types-q-s.md#string) | Less than or equal to. | -| `moreq` - [`String`](types-q-s.md#string) | More than or equal to. | -| `neq` - [`String`](types-q-s.md#string) | Not equal to. | -| `nin` - [`[String]`](types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](types-q-s.md#string) | Not null. | -| `null` - [`String`](types-q-s.md#string) | Is null. | -| `to` - [`String`](types-q-s.md#string) | To. Must be used with the `from` field. | +| `eq` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Equals. | +| `from` - [`String`](/reference/graphql/saas/types-q-s.md#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Greater than. | +| `gteq` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Greater than or equal to. | +| `in` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Less than. | +| `lteq` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Less than or equal to. | +| `moreq` - [`String`](/reference/graphql/saas/types-q-s.md#string) | More than or equal to. | +| `neq` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Not equal to. | +| `nin` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Not null. | +| `null` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Is null. | +| `to` - [`String`](/reference/graphql/saas/types-q-s.md#string) | To. Must be used with the `from` field. | #### Example @@ -251,13 +251,13 @@ Defines the comparison operators that can be used in a filter. "eq": "abc123", "from": "abc123", "gt": "abc123", - "gteq": "abc123", - "in": ["xyz789"], - "like": "abc123", + "gteq": "xyz789", + "in": ["abc123"], + "like": "xyz789", "lt": "xyz789", - "lteq": "xyz789", + "lteq": "abc123", "moreq": "xyz789", - "neq": "abc123", + "neq": "xyz789", "nin": ["xyz789"], "notnull": "xyz789", "null": "xyz789", @@ -275,19 +275,19 @@ Contains product attributes that can be used for filtering in a `productSearch` | Field Name | Description | |------------|-------------| -| `attribute` - [`String!`](types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters and without spaces | -| `frontendInput` - [`String`](types-q-s.md#string) | Indicates how field rendered on storefront | -| `label` - [`String`](types-q-s.md#string) | The display name assigned to the attribute | -| `numeric` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | +| `attribute` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique identifier for an attribute code. This value should be in lowercase letters and without spaces | +| `frontendInput` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates how field rendered on storefront | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name assigned to the attribute | +| `numeric` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | #### Example ```json { "attribute": "xyz789", - "frontendInput": "abc123", + "frontendInput": "xyz789", "label": "abc123", - "numeric": true + "numeric": false } ``` @@ -301,8 +301,8 @@ A single FPT that can be applied to a product price. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | +| `amount` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display label assigned to the Fixed Product Tax. | #### Example @@ -357,12 +357,12 @@ Identifies which customer requires remote shopping assistance. | Input Field | Description | |-------------|-------------| -| `customer_email` - [`String!`](types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | +| `customer_email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address of the customer requesting remote shopping assistance. | #### Example ```json -{"customer_email": "abc123"} +{"customer_email": "xyz789"} ``` @@ -375,12 +375,12 @@ Contains the generated customer token. | Field Name | Description | |------------|-------------| -| `customer_token` - [`String!`](types-q-s.md#string) | The generated customer token. | +| `customer_token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The generated customer token. | #### Example ```json -{"customer_token": "xyz789"} +{"customer_token": "abc123"} ``` @@ -398,7 +398,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -416,7 +416,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": 4} +{"negotiable_quote_uid": "4"} ``` @@ -429,7 +429,7 @@ Gets the payment SDK URLs and values | Field Name | Description | |------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | +| `sdkParams` - [`[PaymentSDKParamsItem]`](/reference/graphql/saas/types-k-p.md#paymentsdkparamsitem) | The payment SDK parameters | #### Example @@ -447,9 +447,9 @@ Contains details about the gift card account. | Field Name | Description | |------------|-------------| -| `balance` - [`Money`](types-k-p.md#money) | The balance remaining on the gift card. | -| `code` - [`String`](types-q-s.md#string) | The gift card account code. | -| `expiration_date` - [`String`](types-q-s.md#string) | The expiration date of the gift card. | +| `balance` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The balance remaining on the gift card. | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The gift card account code. | +| `expiration_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The expiration date of the gift card. | #### Example @@ -457,7 +457,7 @@ Contains details about the gift card account. { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -471,7 +471,7 @@ Contains the gift card code. | Input Field | Description | |-------------|-------------| -| `gift_card_code` - [`String!`](types-q-s.md#string) | The applied gift card code. | +| `gift_card_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The applied gift card code. | #### Example @@ -500,10 +500,10 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { "attribute_id": 123, - "uid": "4", - "value": 123.45, - "website_id": 987, - "website_value": 123.45 + "uid": 4, + "value": 987.65, + "website_id": 123, + "website_value": 987.65 } ``` @@ -517,30 +517,30 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount and currency of the gift card. | +| `amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `backorder_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/saas/types-c-e.md#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!`](types-a-b.md#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!`](types-a-b.md#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. | +| `is_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#string) | The message from the sender to the recipient. | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The message from the sender to the recipient. | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `not_available_message` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `prices` - [`CartItemPrices`](/reference/graphql/saas/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender. | -| `sender_name` - [`String!`](types-q-s.md#string) | The name of the sender. | +| `recipient_email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the sender. | +| `sender_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the sender. | | `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -549,19 +549,19 @@ Contains details about a gift card that has been added to a cart. { "amount": Money, "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": true, - "is_salable": true, + "is_available": false, + "is_salable": false, "max_qty": 123.45, - "message": "abc123", + "message": "xyz789", "min_qty": 987.65, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -569,7 +569,7 @@ Contains details about a gift card that has been added to a cart. "quantity": 987.65, "recipient_email": "abc123", "recipient_name": "xyz789", - "sender_email": "xyz789", + "sender_email": "abc123", "sender_name": "abc123", "uid": 4 } @@ -583,14 +583,14 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the credit memo item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#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`](types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | | `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example @@ -600,12 +600,12 @@ Contains details about a gift card that has been added to a cart. "custom_attributes": [CustomAttribute], "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` @@ -617,14 +617,14 @@ Contains details about a gift card that has been added to a cart. | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -636,9 +636,9 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 987.65 } ``` @@ -653,21 +653,21 @@ Contains details about a gift card. | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the sender of a physical or virtual gift card. | #### Example ```json { "message": "abc123", - "recipient_email": "abc123", + "recipient_email": "xyz789", "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "abc123" + "sender_email": "xyz789", + "sender_name": "xyz789" } ``` @@ -681,13 +681,13 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](types-k-p.md#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](types-k-p.md#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](types-q-s.md#string) | A message to the recipient. | -| `recipient_email` - [`String`](types-q-s.md#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](types-q-s.md#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](types-q-s.md#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](types-q-s.md#string) | The name of the person sending the gift card. | +| `amount` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A message to the recipient. | +| `recipient_email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the person sending the gift card. | #### Example @@ -695,11 +695,11 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "abc123", - "recipient_email": "abc123", + "message": "xyz789", + "recipient_email": "xyz789", "recipient_name": "abc123", "sender_email": "xyz789", - "sender_name": "xyz789" + "sender_name": "abc123" } ``` @@ -711,21 +711,21 @@ Contains details about the sender, recipient, and amount of a gift card. | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](types-k-p.md#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#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`](types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | +| `prices` - [`OrderItemPrices`](/reference/graphql/saas/types-k-p.md#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](/reference/graphql/saas/types-k-p.md#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/saas/types-q-s.md#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. | @@ -733,8 +733,8 @@ Contains details about the sender, recipient, and amount of a gift card. | `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]`](types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `selected_options` - [`[OrderItemOption]`](/reference/graphql/saas/types-k-p.md#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the order item. | #### Example @@ -747,21 +747,21 @@ Contains details about the sender, recipient, and amount of a gift card. "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "product_type": "abc123", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" } @@ -777,94 +777,94 @@ Defines properties of a gift card. | Field Name | Description | |------------|-------------| -| `allow_message` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](types-a-b.md#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `allow_message` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `canonical_url` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](/reference/graphql/saas/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/saas/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](/reference/graphql/saas/types-c-e.md#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/saas/types-k-p.md#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`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/saas/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/saas/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/saas/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | | `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#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_message": false, "allow_open_amount": false, - "canonical_url": "xyz789", + "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_message_available": true, "gift_wrapping_available": true, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", "image": ProductImage, - "is_redeemable": false, + "is_redeemable": true, "is_returnable": "abc123", "lifetime": 123, - "manufacturer": 987, - "max_sale_qty": 987.65, + "manufacturer": 123, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "message_max_length": 987, "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 123.45, + "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": 987.65, + "new_to_date": "abc123", + "only_x_left_in_stock": 123.45, "open_amount_max": 987.65, - "open_amount_min": 987.65, + "open_amount_min": 123.45, "options": [CustomizableOptionInterface], "options_container": "abc123", "price_range": PriceRange, @@ -873,17 +873,17 @@ Defines properties of a gift card. "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 123.45, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789", - "weight": 987.65 + "url_key": "abc123", + "weight": 123.45 } ``` @@ -897,11 +897,11 @@ Contains details about gift cards added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#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!`](types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#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!`](types-q-s.md#string) | The product SKU. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The product SKU. | | `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | #### Example @@ -912,8 +912,8 @@ Contains details about gift cards added to a requisition list. "gift_card_options": GiftCardOptions, "product": ProductInterface, "quantity": 123.45, - "sku": "abc123", - "uid": 4 + "sku": "xyz789", + "uid": "4" } ``` @@ -927,10 +927,10 @@ Contains details about gift cards added to a requisition list. |------------|-------------| | `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`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | | `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example @@ -977,25 +977,25 @@ A single gift card added to a wish list. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#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!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#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", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "gift_card_options": GiftCardOptions, "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1009,16 +1009,16 @@ Contains the text of a gift message, its sender, and recipient | Field Name | Description | |------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | Sender name | -| `message` - [`String!`](types-q-s.md#string) | Gift message text | -| `to` - [`String!`](types-q-s.md#string) | Recipient name | +| `from` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Sender name | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Gift message text | +| `to` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Recipient name | #### Example ```json { - "from": "abc123", - "message": "abc123", + "from": "xyz789", + "message": "xyz789", "to": "xyz789" } ``` @@ -1033,16 +1033,16 @@ Defines a gift message. | Input Field | Description | |-------------|-------------| -| `from` - [`String!`](types-q-s.md#string) | The name of the sender. | -| `message` - [`String!`](types-q-s.md#string) | The text of the gift message. | -| `to` - [`String!`](types-q-s.md#string) | The name of the recepient. | +| `from` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the sender. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The text of the gift message. | +| `to` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the recepient. | #### Example ```json { "from": "xyz789", - "message": "abc123", + "message": "xyz789", "to": "xyz789" } ``` @@ -1057,12 +1057,12 @@ Contains prices for gift wrapping options. | Field Name | Description | |------------|-------------| -| `gift_wrapping_for_items` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_items_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | -| `gift_wrapping_for_order` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order. | -| `gift_wrapping_for_order_incl_tax` - [`Money`](types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | -| `printed_card` - [`Money`](types-k-p.md#money) | Price for the printed card. | -| `printed_card_incl_tax` - [`Money`](types-k-p.md#money) | Price for the printed card including tax. | +| `gift_wrapping_for_items` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Price for the printed card including tax. | #### Example @@ -1087,15 +1087,15 @@ Contains details about a gift registry. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#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!`](types-q-s.md#string) | The name of the event. | +| `event_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the event. | | `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](types-q-s.md#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](types-q-s.md#string) | The customer who created the gift registry. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](/reference/graphql/saas/types-q-s.md#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`](types-c-e.md#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `shipping_address` - [`CustomerAddress`](/reference/graphql/saas/types-c-e.md#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. | @@ -1104,18 +1104,18 @@ Contains details about a gift registry. ```json { - "created_at": "abc123", + "created_at": "xyz789", "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "abc123", + "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "abc123", + "message": "abc123", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } ``` @@ -1129,17 +1129,17 @@ Contains details about a gift registry. |------------|-------------| | `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!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": "4", + "code": 4, "group": "EVENT_INFORMATION", - "label": "abc123", - "value": "xyz789" + "label": "xyz789", + "value": "abc123" } ``` @@ -1177,7 +1177,7 @@ Defines a dynamic attribute. | Input Field | Description | |-------------|-------------| | `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](types-q-s.md#string) | A string that describes a dynamic attribute. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A string that describes a dynamic attribute. | #### Example @@ -1194,8 +1194,8 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A corresponding value for the code. | #### Possible Types @@ -1222,11 +1222,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Example @@ -1237,7 +1237,7 @@ Defines a dynamic attribute. "code": 4, "input_type": "xyz789", "is_required": false, - "label": "abc123", + "label": "xyz789", "sort_order": 123 } ``` @@ -1250,11 +1250,11 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `attribute_group` - [`String!`](types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | +| `attribute_group` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Indicates which group the dynamic attribute a member of. | | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | +| `input_type` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the dynamic attribute. | | `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | #### Possible Types @@ -1267,12 +1267,12 @@ Defines a dynamic attribute. ```json { - "attribute_group": "abc123", + "attribute_group": "xyz789", "code": 4, "input_type": "abc123", - "is_required": true, - "label": "abc123", - "sort_order": 123 + "is_required": false, + "label": "xyz789", + "sort_order": 987 } ``` @@ -1284,9 +1284,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about the gift registry item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#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. | @@ -1295,11 +1295,11 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", - "note": "xyz789", + "created_at": "xyz789", + "note": "abc123", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 987.65, + "quantity_fulfilled": 123.45, "uid": "4" } ``` @@ -1312,9 +1312,9 @@ Defines a dynamic attribute. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | The date the product was added to the gift registry. | -| `note` - [`String`](types-q-s.md#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about the gift registry item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the product was added to the gift registry. | +| `note` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#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. | @@ -1333,7 +1333,7 @@ Defines a dynamic attribute. "note": "xyz789", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 123.45, + "quantity_fulfilled": 987.65, "uid": "4" } ``` @@ -1348,14 +1348,14 @@ Contains the status and any errors that encountered with the customer's gift reg | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `status` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/saas/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1379,7 +1379,7 @@ Contains details about an error that occurred when processing a gift registry it | `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!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | | `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | #### Example @@ -1388,8 +1388,8 @@ Contains details about an error that occurred when processing a gift registry it { "code": "OUT_OF_STOCK", "gift_registry_item_uid": "4", - "gift_registry_uid": 4, - "message": "abc123", + "gift_registry_uid": "4", + "message": "xyz789", "product_uid": "4" } ``` @@ -1430,7 +1430,7 @@ Contains the customer's gift registry. | GiftRegistryOutputInterface Types | |----------------| -| [`MoveCartItemsToGiftRegistryOutput`](types-k-p.md#movecartitemstogiftregistryoutput) | +| [`MoveCartItemsToGiftRegistryOutput`](/reference/graphql/saas/types-k-p.md#movecartitemstogiftregistryoutput) | #### Example @@ -1468,9 +1468,9 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the registrant. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the registrant. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the registrant. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the registrant. | | `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | #### Example @@ -1480,10 +1480,10 @@ Contains details about a registrant. "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "xyz789", - "firstname": "xyz789", - "lastname": "xyz789", - "uid": 4 + "email": "abc123", + "firstname": "abc123", + "lastname": "abc123", + "uid": "4" } ``` @@ -1496,15 +1496,15 @@ Contains details about a registrant. | Field Name | Description | |------------|-------------| | `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](types-q-s.md#string) | A corresponding value for the code. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A corresponding value for the code. | #### Example ```json { - "code": 4, - "label": "abc123", + "code": "4", + "label": "xyz789", "value": "abc123" } ``` @@ -1519,23 +1519,23 @@ Contains the results of a gift registry search. | Field Name | Description | |------------|-------------| -| `event_date` - [`String`](types-q-s.md#string) | The date of the event. | -| `event_title` - [`String!`](types-q-s.md#string) | The title given to the event. | +| `event_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The date of the event. | +| `event_title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The title given to the event. | | `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](types-q-s.md#string) | The location of the event. | -| `name` - [`String!`](types-q-s.md#string) | The name of the gift registry owner. | -| `type` - [`String`](types-q-s.md#string) | The type of event being held. | +| `location` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The location of the event. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the gift registry owner. | +| `type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of event being held. | #### Example ```json { "event_date": "abc123", - "event_title": "abc123", - "gift_registry_uid": 4, + "event_title": "xyz789", + "gift_registry_uid": "4", "location": "abc123", - "name": "xyz789", - "type": "xyz789" + "name": "abc123", + "type": "abc123" } ``` @@ -1549,7 +1549,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or | Input Field | Description | |-------------|-------------| -| `address_data` - [`CustomerAddressInput`](types-c-e.md#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_data` - [`CustomerAddressInput`](/reference/graphql/saas/types-c-e.md#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. | @@ -1593,7 +1593,7 @@ Contains details about a gift registry type. | 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!`](types-q-s.md#string) | The label assigned to the gift registry type on the Admin. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#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 @@ -1603,8 +1603,8 @@ Contains details about a gift registry type. "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", - "uid": 4 + "label": "abc123", + "uid": "4" } ``` @@ -1618,9 +1618,9 @@ Contains details about the selected or available gift wrapping options. | Field Name | Description | |------------|-------------| -| `design` - [`String!`](types-q-s.md#string) | The name of the gift wrapping design. | +| `design` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the gift wrapping design. | | `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | -| `price` - [`Money!`](types-k-p.md#money) | The gift wrapping price. | +| `price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The gift wrapping price. | | `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | #### Example @@ -1630,7 +1630,7 @@ Contains details about the selected or available gift wrapping options. "design": "abc123", "image": GiftWrappingImage, "price": Money, - "uid": 4 + "uid": "4" } ``` @@ -1644,15 +1644,15 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The gift wrapping preview image label. | -| `url` - [`String!`](types-q-s.md#string) | The gift wrapping preview image URL. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The gift wrapping preview image label. | +| `url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The gift wrapping preview image URL. | #### Example ```json { "label": "xyz789", - "url": "abc123" + "url": "xyz789" } ``` @@ -1664,16 +1664,16 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| -| `color` - [`String`](types-q-s.md#string) | The button color | +| `color` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The button color | | `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](types-q-s.md#string) | The button type | +| `type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The button type | #### Example ```json { "color": "xyz789", - "height": 987, + "height": 123, "type": "abc123" } ``` @@ -1687,15 +1687,15 @@ Points to an image associated with a gift wrapping option. | Field Name | Description | |------------|-------------| | `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment method code as defined in the payment gateway | | `google_pay_mode` - [`GooglePayMode`](#googlepaymode) | Google Pay mode | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `is_visible` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/saas/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/saas/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name displayed for the payment method | #### Example @@ -1706,7 +1706,7 @@ Points to an image associated with a gift wrapping option. "google_pay_mode": "TEST", "is_visible": true, "payment_intent": "abc123", - "payment_source": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", @@ -1724,9 +1724,9 @@ Google Pay inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | PayPal order ID | #### Example @@ -1767,80 +1767,80 @@ Defines a grouped product, which consists of simple standalone products that are | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | +| `canonical_url` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](/reference/graphql/saas/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/saas/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for new product listings. | | `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `options_container` - [`String`](/reference/graphql/saas/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | | `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#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`](types-q-s.md#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `special_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/saas/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | | `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#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", + "canonical_url": "xyz789", "categories": [CategoryInterface], "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "items": [GroupedProductItem], "manufacturer": 123, - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", + "name": "abc123", "new_from_date": "xyz789", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, "sku": "abc123", @@ -1850,10 +1850,10 @@ Defines a grouped product, which consists of simple standalone products that are "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], - "url_key": "abc123", - "weight": 987.65 + "url_key": "xyz789", + "weight": 123.45 } ``` @@ -1868,7 +1868,7 @@ Contains information about an individual grouped product item. | Field Name | Description | |------------|-------------| | `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about this product option. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#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 @@ -1891,11 +1891,11 @@ A grouped product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | +| `added_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The description of the item. | | `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#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 @@ -1921,8 +1921,8 @@ Input to retrieve a guest order based on token. | Input Field | Description | |-------------|-------------| -| `reason` - [`String!`](types-q-s.md#string) | Cancellation reason. | -| `token` - [`String!`](types-q-s.md#string) | Order token. | +| `reason` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Cancellation reason. | +| `token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Order token. | #### Example @@ -1943,17 +1943,17 @@ Input to retrieve an order based on details. | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](types-q-s.md#string) | Order billing address email. | -| `lastname` - [`String!`](types-q-s.md#string) | Order billing address lastname. | -| `number` - [`String!`](types-q-s.md#string) | Order number. | +| `email` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Order billing address email. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Order billing address lastname. | +| `number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Order number. | #### Example ```json { - "email": "xyz789", + "email": "abc123", "lastname": "xyz789", - "number": "xyz789" + "number": "abc123" } ``` @@ -1967,9 +1967,9 @@ An object that provides highlighted text for matched words | Field Name | Description | |------------|-------------| -| `attribute` - [`String!`](types-q-s.md#string) | The product attribute that contains a match for the search phrase | -| `matched_words` - [`[String]!`](types-q-s.md#string) | An array of strings | -| `value` - [`String!`](types-q-s.md#string) | The matched text, enclosed within emphasis tags | +| `attribute` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The product attribute that contains a match for the search phrase | +| `matched_words` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array of strings | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The matched text, enclosed within emphasis tags | #### Example @@ -1991,22 +1991,22 @@ Item note data that is added to the negotiable quote history object. | Field Name | Description | |------------|-------------| -| `created_at` - [`String!`](types-q-s.md#string) | Datetime of the note added. | -| `creator_name` - [`String!`](types-q-s.md#string) | Name of the creator. | -| `creator_type` - [`String!`](types-q-s.md#string) | Creator type: Buyer or Seller. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Datetime of the note added. | +| `creator_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Name of the creator. | +| `creator_type` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Creator type: Buyer or Seller. | | `item_id` - [`Int!`](#int) | Id of the quote item for which the note has been added. | -| `note` - [`String!`](types-q-s.md#string) | The note added by the creator for the item | -| `product_name` - [`String!`](types-q-s.md#string) | Name of the quote item product for which note has been added. | +| `note` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The note added by the creator for the item | +| `product_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Name of the quote item product for which note has been added. | #### Example ```json { "created_at": "abc123", - "creator_name": "abc123", + "creator_name": "xyz789", "creator_type": "xyz789", "item_id": 123, - "note": "xyz789", + "note": "abc123", "product_name": "abc123" } ``` @@ -2019,33 +2019,33 @@ Item note data that is added to the negotiable quote history object. | Field Name | Description | |------------|-------------| -| `cc_vault_code` - [`String`](types-q-s.md#string) | Vault payment method code | -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](types-a-b.md#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](types-t-z.md#threedsmode) | 3DS mode | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `cc_vault_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Vault payment method code | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/saas/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](/reference/graphql/saas/types-t-z.md#threedsmode) | 3DS mode | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name displayed for the payment method | #### Example ```json { - "cc_vault_code": "xyz789", + "cc_vault_code": "abc123", "code": "xyz789", "is_vault_enabled": true, - "is_visible": false, + "is_visible": true, "payment_intent": "xyz789", "payment_source": "xyz789", "requires_card_details": false, "sdk_params": [SDKParams], "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "abc123" + "title": "xyz789" } ``` @@ -2059,27 +2059,27 @@ Hosted Fields payment inputs | Input Field | Description | |-------------|-------------| -| `cardBin` - [`String`](types-q-s.md#string) | Card bin number | -| `cardExpiryMonth` - [`String`](types-q-s.md#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](types-q-s.md#string) | Expiration year of the card | -| `cardLast4` - [`String`](types-q-s.md#string) | Last four digits of the card | -| `holderName` - [`String`](types-q-s.md#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](types-a-b.md#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`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | +| `cardBin` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Card bin number | +| `cardExpiryMonth` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Expiration year of the card | +| `cardLast4` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Last four digits of the card | +| `holderName` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#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", + "cardBin": "abc123", + "cardExpiryMonth": "xyz789", + "cardExpiryYear": "xyz789", + "cardLast4": "abc123", + "holderName": "xyz789", + "is_active_payment_token_enabler": false, + "payment_source": "abc123", "payments_order_id": "abc123", "paypal_order_id": "abc123" } @@ -2105,15 +2105,15 @@ The `ID` scalar type represents a unique identifier, often used to refetch an ob | Field Name | Description | |------------|-------------| -| `thumbnail` - [`String`](types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `thumbnail` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json { "thumbnail": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -2127,8 +2127,8 @@ Result of importing a shared requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The imported requisition list for the current customer. | -| `user_errors` - [`[ShareRequisitionListUserError]!`](types-q-s.md#sharerequisitionlistusererror) | Validation or import issues. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The imported requisition list for the current customer. | +| `user_errors` - [`[ShareRequisitionListUserError]!`](/reference/graphql/saas/types-q-s.md#sharerequisitionlistusererror) | Validation or import issues. | #### Example @@ -2169,8 +2169,8 @@ List of templates/filters applied to customer attribute input. | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `code` - [`CartUserInputErrorType!`](/reference/graphql/saas/types-c-e.md#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | | `quantity` - [`Float`](#float) | Amount of available stock | #### Example @@ -2178,7 +2178,7 @@ List of templates/filters applied to customer attribute input. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123", + "message": "xyz789", "quantity": 123.45 } ``` @@ -2192,7 +2192,7 @@ The `Int` scalar type represents non-fractional signed whole numeric values. Int #### Example ```json -123 +987 ``` @@ -2205,12 +2205,12 @@ Contains an error message when an internal error occurred. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The returned error message. | #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -2223,11 +2223,11 @@ Contains invoice details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments on the invoice. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/saas/types-q-s.md#salescommentitem) | Comments on the invoice. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#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!`](types-q-s.md#string) | Sequential invoice number. | +| `number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Sequential invoice number. | | `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | #### Example @@ -2236,9 +2236,9 @@ Contains invoice details. { "comments": [SalesCommentItem], "custom_attributes": [CustomAttribute], - "id": "4", + "id": 4, "items": [InvoiceItemInterface], - "number": "xyz789", + "number": "abc123", "total": InvoiceTotal } ``` @@ -2253,15 +2253,15 @@ Defines an invoice custom attributes. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for invoice. | -| `invoice_id` - [`String!`](types-q-s.md#string) | The invoice ID. | +| `custom_attributes` - [`[CustomAttributeInput]`](/reference/graphql/saas/types-c-e.md#customattributeinput) | An array of custom attributes for invoice. | +| `invoice_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The invoice ID. | #### Example ```json { "custom_attributes": [CustomAttributeInput], - "invoice_id": "xyz789" + "invoice_id": "abc123" } ``` @@ -2273,13 +2273,13 @@ Defines an invoice custom attributes. | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -2290,7 +2290,7 @@ Defines an invoice custom attributes. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "quantity_invoiced": 987.65 @@ -2307,17 +2307,17 @@ Defines an invoice item custom attributes. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for invoice item. | -| `invoice_id` - [`String!`](types-q-s.md#string) | The invoice ID. | -| `invoice_item_id` - [`String!`](types-q-s.md#string) | The invoice item ID. | +| `custom_attributes` - [`[CustomAttributeInput]`](/reference/graphql/saas/types-c-e.md#customattributeinput) | An array of custom attributes for invoice item. | +| `invoice_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The invoice ID. | +| `invoice_item_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The invoice item ID. | #### Example ```json { "custom_attributes": [CustomAttributeInput], - "invoice_id": "abc123", - "invoice_item_id": "abc123" + "invoice_id": "xyz789", + "invoice_item_id": "xyz789" } ``` @@ -2331,21 +2331,21 @@ Contains detailes about invoiced items. | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#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`](types-k-p.md#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](types-q-s.md#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the base product. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | | `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Possible Types | InvoiceItemInterface Types | |----------------| -| [`BundleInvoiceItem`](types-a-b.md#bundleinvoiceitem) | -| [`DownloadableInvoiceItem`](types-c-e.md#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](/reference/graphql/saas/types-a-b.md#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](/reference/graphql/saas/types-c-e.md#downloadableinvoiceitem) | | [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | | [`InvoiceItem`](#invoiceitem) | @@ -2355,9 +2355,9 @@ Contains detailes about invoiced items. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "quantity_invoiced": 123.45 @@ -2392,14 +2392,14 @@ Contains price details from an invoice. | Field Name | Description | |------------|-------------| -| `base_grand_total` - [`Money!`](types-k-p.md#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](types-k-p.md#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the invoice. | +| `base_grand_total` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/saas/types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](/reference/graphql/saas/types-t-z.md#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The amount of tax applied to the invoice. | #### Example @@ -2426,7 +2426,7 @@ Contains the response of a company admin email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | +| `is_email_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company administrator. | #### Example @@ -2444,7 +2444,7 @@ Contains the response of a company email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | +| `is_email_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company. | #### Example @@ -2462,12 +2462,12 @@ Contains the response of a role name validation query. | Field Name | Description | |------------|-------------| -| `is_role_name_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified company role name is available. | +| `is_role_name_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the specified company role name is available. | #### Example ```json -{"is_role_name_available": false} +{"is_role_name_available": true} ``` @@ -2480,12 +2480,12 @@ Contains the response of a company user email validation query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | +| `is_email_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a company user. | #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2498,7 +2498,7 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `is_email_available` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | +| `is_email_available` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the specified email address can be used to create a customer. | #### Example @@ -2515,7 +2515,7 @@ Contains the result of the `isEmailAvailable` query. | Input Field | Description | |-------------|-------------| | `type` - [`IsOperatorType`](#isoperatortype) | | -| `value` - [`Boolean`](types-a-b.md#boolean) | | +| `value` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | | #### Example @@ -2548,8 +2548,8 @@ Contains the result of the `isEmailAvailable` query. | Field Name | Description | |------------|-------------| -| `isSubscribed` - [`Boolean!`](types-a-b.md#boolean) | | -| `message` - [`String`](types-q-s.md#string) | | +| `isSubscribed` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -2567,23 +2567,23 @@ The note object for quote line item. | Field Name | Description | |------------|-------------| -| `created_at` - [`String`](types-q-s.md#string) | Timestamp that reflects note creation date. | +| `created_at` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Timestamp that reflects note creation date. | | `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | -| `creator_name` - [`String`](types-q-s.md#string) | Name of the creator. | +| `creator_name` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | Note text. | +| `note` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Note text. | | `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | #### Example ```json { - "created_at": "xyz789", + "created_at": "abc123", "creator_id": 123, - "creator_name": "abc123", + "creator_name": "xyz789", "creator_type": 123, - "negotiable_quote_item_uid": 4, + "negotiable_quote_item_uid": "4", "note": "xyz789", "note_uid": "4" } @@ -2599,7 +2599,7 @@ A list of options of the selected bundle product. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The label of the option. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#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. | @@ -2607,7 +2607,7 @@ A list of options of the selected bundle product. ```json { - "label": "abc123", + "label": "xyz789", "uid": "4", "values": [ItemSelectedBundleOptionValue] } @@ -2623,9 +2623,9 @@ A list of values for the selected bundle product. | Field Name | Description | |------------|-------------| -| `price` - [`Money!`](types-k-p.md#money) | The price of the child bundle product. | -| `product_name` - [`String!`](types-q-s.md#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](types-q-s.md#string) | The SKU of the child bundle product. | +| `price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The price of the child bundle product. | +| `product_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#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. | @@ -2636,7 +2636,7 @@ A list of values for the selected bundle product. "price": Money, "product_name": "abc123", "product_sku": "abc123", - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -2661,14 +2661,14 @@ A JSON scalar | Input Field | Description | |-------------|-------------| -| `key` - [`String!`](types-q-s.md#string) | The unique key identifier from the upload | -| `media_resource_type` - [`MediaResourceType!`](types-k-p.md#mediaresourcetype) | The type of media resource being uploaded | +| `key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique key identifier from the upload | +| `media_resource_type` - [`MediaResourceType!`](/reference/graphql/saas/types-k-p.md#mediaresourcetype) | The type of media resource being uploaded | #### Example ```json { - "key": "abc123", + "key": "xyz789", "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" } ``` @@ -2681,9 +2681,9 @@ A JSON scalar | Field Name | Description | |------------|-------------| -| `key` - [`String!`](types-q-s.md#string) | The unique key identifier | -| `message` - [`String`](types-q-s.md#string) | Additional information about the confirmation | -| `success` - [`Boolean!`](types-a-b.md#boolean) | Whether the confirmation was successful | +| `key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique key identifier | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Additional information about the confirmation | +| `success` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the confirmation was successful | #### Example @@ -2691,7 +2691,7 @@ A JSON scalar { "key": "xyz789", "message": "abc123", - "success": true + "success": false } ``` @@ -2703,8 +2703,8 @@ A JSON scalar | Input Field | Description | |-------------|-------------| -| `key` - [`String!`](types-q-s.md#string) | The name of the file to be uploaded, cannot contain slashes | -| `media_resource_type` - [`MediaResourceType!`](types-k-p.md#mediaresourcetype) | The type of media resource being uploaded | +| `key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the file to be uploaded, cannot contain slashes | +| `media_resource_type` - [`MediaResourceType!`](/reference/graphql/saas/types-k-p.md#mediaresourcetype) | The type of media resource being uploaded | #### Example @@ -2723,16 +2723,16 @@ A JSON scalar | Field Name | Description | |------------|-------------| -| `expires_at` - [`String!`](types-q-s.md#string) | The expiration timestamp of the URL | -| `key` - [`String!`](types-q-s.md#string) | The unique key identifier for the upload | -| `upload_url` - [`String!`](types-q-s.md#string) | The presigned URL for uploading the file | +| `expires_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The expiration timestamp of the URL | +| `key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique key identifier for the upload | +| `upload_url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The presigned URL for uploading the file | #### Example ```json { - "expires_at": "abc123", + "expires_at": "xyz789", "key": "abc123", - "upload_url": "xyz789" + "upload_url": "abc123" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md index afae8dc51..385129adc 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md @@ -8,15 +8,15 @@ Contains a key-value pair. | Field Name | Description | |------------|-------------| -| `name` - [`String`](types-q-s.md#string) | The name part of the key/value pair. | -| `value` - [`String`](types-q-s.md#string) | The value part of the key/value pair. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name part of the key/value pair. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value part of the key/value pair. | #### Example ```json { - "name": "xyz789", - "value": "abc123" + "name": "abc123", + "value": "xyz789" } ``` @@ -50,17 +50,17 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `note` - [`String`](types-q-s.md#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `note` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "note": "abc123", - "quote_item_uid": "4", - "quote_uid": 4 + "note": "xyz789", + "quote_item_uid": 4, + "quote_uid": "4" } ``` @@ -74,17 +74,17 @@ Contains basic information about a product image or video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL of the product image or video. | #### Possible Types | MediaGalleryInterface Types | |----------------| -| [`AssetImage`](types-a-b.md#assetimage) | -| [`AssetVideo`](types-a-b.md#assetvideo) | +| [`AssetImage`](/reference/graphql/saas/types-a-b.md#assetimage) | +| [`AssetVideo`](/reference/graphql/saas/types-a-b.md#assetvideo) | | [`ProductImage`](#productimage) | | [`ProductVideo`](#productvideo) | @@ -94,7 +94,7 @@ Contains basic information about a product image or video. { "disabled": true, "label": "xyz789", - "position": 123, + "position": 987, "url": "xyz789" } ``` @@ -129,7 +129,7 @@ Enumeration of media resource types | Field Name | Description | |------------|-------------| -| `type` - [`String`](types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | +| `type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of logo for the PayPal Pay Later messaging | #### Example @@ -145,7 +145,7 @@ Enumeration of media resource types | Field Name | Description | |------------|-------------| -| `layout` - [`String`](types-q-s.md#string) | The message layout | +| `layout` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The message layout | | `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example @@ -167,8 +167,8 @@ Defines a monetary value, including a numeric value and a currency code. | Field Name | Description | |------------|-------------| -| `currency` - [`CurrencyEnum`](types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | +| `currency` - [`CurrencyEnum`](/reference/graphql/saas/types-c-e.md#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | A number expressing a monetary value. | #### Example @@ -186,16 +186,16 @@ Contains the customer's gift registry and any errors encountered. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](/reference/graphql/saas/types-f-i.md#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example ```json { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -210,12 +210,12 @@ An input object that defines the items in a requisition list to be moved. | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | +| `requisitionListItemUids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -228,8 +228,8 @@ Output of the request to move items to another requisition list. | Field Name | Description | |------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The source requisition list after moving items. | +| `destination_requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The source requisition list after moving items. | #### Example @@ -250,17 +250,17 @@ Move Line Item to Requisition List. | Input Field | Description | |-------------|-------------| -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a requisition list. | +| `quote_item_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a requisition list. | #### Example ```json { - "quote_item_uid": "4", - "quote_uid": 4, - "requisition_list_uid": "4" + "quote_item_uid": 4, + "quote_uid": "4", + "requisition_list_uid": 4 } ``` @@ -292,9 +292,9 @@ Contains the source and target wish lists after moving products. | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | +| `destination_wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/saas/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example @@ -316,29 +316,29 @@ Contains details about a negotiable quote. | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](types-a-b.md#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the negotiable quote | -| `email` - [`String`](types-q-s.md#string) | The email address of the company user. | -| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote. | +| `created_at` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote was created. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the negotiable quote | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The email address of the company user. | +| `expiration_date` - [`String!`](/reference/graphql/saas/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote. | -| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The order created from the negotiable quote. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | -| `selected_payment_method` - [`SelectedPaymentMethod`](types-q-s.md#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `is_virtual` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/saas/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The title assigned to the negotiable quote. | +| `order` - [`CustomerOrder`](/reference/graphql/saas/types-c-e.md#customerorder) | The order created from the negotiable quote. | +| `prices` - [`CartPrices`](/reference/graphql/saas/types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `sales_rep_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first and last name of the sales representative. | +| `selected_payment_method` - [`SelectedPaymentMethod`](/reference/graphql/saas/types-q-s.md#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`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `template_name` - [`String`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | +| `template_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `total_quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote was updated. | #### Example @@ -351,22 +351,22 @@ Contains details about a negotiable quote. "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "order": CustomerOrder, "prices": CartPrices, "sales_rep_name": "xyz789", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", - "template_id": "4", + "template_id": 4, "template_name": "xyz789", - "total_quantity": 123.45, - "uid": 4, - "updated_at": "abc123" + "total_quantity": 987.65, + "uid": "4", + "updated_at": "xyz789" } ``` @@ -380,15 +380,15 @@ Defines the company's country. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The address country code. | -| `label` - [`String!`](types-q-s.md#string) | The display name of the region. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The address country code. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display name of the region. | #### Example ```json { "code": "abc123", - "label": "xyz789" + "label": "abc123" } ``` @@ -402,44 +402,44 @@ Defines the billing or shipping address to be applied to the cart. | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](types-q-s.md#string) | The company name. | -| `country_code` - [`String!`](types-q-s.md#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping negotiable quote address. | -| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](types-q-s.md#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company name. | +| `country_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](/reference/graphql/saas/types-a-b.md#attributevalueinput) | The custom attribute values of the billing or shipping negotiable quote address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", - "country_code": "abc123", + "country_code": "xyz789", "custom_attributes": [AttributeValueInput], "fax": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", - "region": "xyz789", + "region": "abc123", "region_id": 987, - "save_in_address_book": false, + "save_in_address_book": true, "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", + "telephone": "abc123", "vat_id": "xyz789" } ``` @@ -452,23 +452,23 @@ Defines the billing or shipping address to be applied to the cart. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributes` - [`[AttributeValueInterface]`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#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]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the negotiable quote address. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Possible Types @@ -481,23 +481,23 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", + "customer_address_uid": "4", + "fax": "abc123", "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "abc123", "prefix": "xyz789", "region": NegotiableQuoteAddressRegion, "street": ["xyz789"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": "4", - "vat_id": "xyz789" + "telephone": "abc123", + "uid": 4, + "vat_id": "abc123" } ``` @@ -511,17 +511,17 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The address region code. | -| `label` - [`String`](types-q-s.md#string) | The display name of the region. | -| `region_id` - [`Int`](types-f-i.md#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The address region code. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the region. | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The unique ID for a pre-defined region. | #### Example ```json { - "code": "abc123", - "label": "abc123", - "region_id": 987 + "code": "xyz789", + "label": "xyz789", + "region_id": 123 } ``` @@ -533,44 +533,44 @@ Defines the company's state or province. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributes` - [`[AttributeValueInterface]`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#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]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the negotiable quote address. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", + "customer_address_uid": 4, "fax": "abc123", "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "abc123", "prefix": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "abc123", - "telephone": "abc123", - "uid": "4", + "telephone": "xyz789", + "uid": 4, "vat_id": "xyz789" } ``` @@ -586,9 +586,9 @@ Defines the billing address. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example @@ -597,7 +597,7 @@ Defines the billing address. "address": NegotiableQuoteAddressInput, "customer_address_uid": 4, "same_as_shipping": true, - "use_for_shipping": false + "use_for_shipping": true } ``` @@ -613,10 +613,10 @@ Contains a single plain text comment from either the buyer or seller. |------------|-------------| | `attachments` - [`[NegotiableQuoteCommentAttachment]!`](#negotiablequotecommentattachment) | Negotiable quote comment file attachments. | | `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the comment was created. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the comment was created. | | `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](types-q-s.md#string) | The plain text comment. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | +| `text` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The plain text comment. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example @@ -624,10 +624,10 @@ Contains a single plain text comment from either the buyer or seller. { "attachments": [NegotiableQuoteCommentAttachment], "author": NegotiableQuoteUser, - "created_at": "xyz789", + "created_at": "abc123", "creator_type": "BUYER", "text": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -641,8 +641,8 @@ Negotiable quote comment file attachment. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | Negotiable quote comment attachment file name. | -| `url` - [`String!`](types-q-s.md#string) | Negotiable quote comment attachment file url. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Negotiable quote comment attachment file name. | +| `url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Negotiable quote comment attachment file url. | #### Example @@ -663,12 +663,12 @@ Negotiable quote comment file attachment. | Input Field | Description | |-------------|-------------| -| `key` - [`String!`](types-q-s.md#string) | Negotiable quote comment attachment file key. | +| `key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Negotiable quote comment attachment file key. | #### Example ```json -{"key": "xyz789"} +{"key": "abc123"} ``` @@ -699,14 +699,14 @@ Contains the commend provided by the buyer. | Input Field | Description | |-------------|-------------| | `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](#negotiablequotecommentattachmentinput) | Negotiable quote comment file attachments. | -| `comment` - [`String!`](types-q-s.md#string) | The comment provided by the buyer. | +| `comment` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The comment provided by the buyer. | #### Example ```json { "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "abc123" + "comment": "xyz789" } ``` @@ -720,16 +720,16 @@ Contains custom log entries added by third-party extensions. | Field Name | Description | |------------|-------------| -| `new_value` - [`String!`](types-q-s.md#string) | The new entry content. | -| `old_value` - [`String`](types-q-s.md#string) | The previous entry in the custom log. | -| `title` - [`String!`](types-q-s.md#string) | The title of the custom log entry. | +| `new_value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The new entry content. | +| `old_value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The previous entry in the custom log. | +| `title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The title of the custom log entry. | #### Example ```json { - "new_value": "abc123", - "old_value": "xyz789", + "new_value": "xyz789", + "old_value": "abc123", "title": "abc123" } ``` @@ -744,8 +744,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | +| `ids` - [`FilterEqualTypeInput`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/saas/types-f-i.md#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example @@ -796,12 +796,12 @@ Contains a comment submitted by a seller or buyer. | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | +| `comment` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{"comment": "xyz789"} +{"comment": "abc123"} ``` @@ -817,9 +817,9 @@ Contains details about a change for a negotiable quote. | `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`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | -| `item_note` - [`HistoryItemNoteData`](types-f-i.md#historyitemnotedata) | Item note data that is added to the negotiable quote history object. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `created_at` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `item_note` - [`HistoryItemNoteData`](/reference/graphql/saas/types-f-i.md#historyitemnotedata) | Item note data that is added to the negotiable quote history object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -828,7 +828,7 @@ Contains details about a change for a negotiable quote. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", + "created_at": "xyz789", "item_note": HistoryItemNoteData, "uid": "4" } @@ -863,15 +863,15 @@ Contains a new expiration date and the previous date. | Field Name | Description | |------------|-------------| -| `new_expiration` - [`String`](types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | +| `new_expiration` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { "new_expiration": "abc123", - "old_expiration": "abc123" + "old_expiration": "xyz789" } ``` @@ -885,14 +885,14 @@ Contains lists of products that have been removed from the catalog and negotiabl | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](types-f-i.md#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_catalog` - [`[ID]`](/reference/graphql/saas/types-f-i.md#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_catalog": ["4"], "products_removed_from_quote": [ProductInterface] } ``` @@ -966,7 +966,7 @@ An error indicating that an operation was attempted on a negotiable quote in an | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The returned error message. | #### Example @@ -984,8 +984,8 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | #### Example @@ -1003,8 +1003,8 @@ Defines the payment method to be applied to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | Payment method code | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Payment method code | +| `purchase_order_number` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example @@ -1025,17 +1025,17 @@ Contains a reference document link for a negotiable quote template. | Field Name | Description | |------------|-------------| -| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | -| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | -| `link_id` - [`ID!`](types-f-i.md#id) | The unique ID of a reference document link. | -| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | +| `document_identifier` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The URL of the reference document. | #### Example ```json { "document_identifier": "abc123", - "document_name": "abc123", + "document_name": "xyz789", "link_id": "4", "reference_document_url": "xyz789" } @@ -1049,25 +1049,25 @@ Contains a reference document link for a negotiable quote template. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](types-q-s.md#string) | The company's city or town. | -| `company` - [`String`](types-q-s.md#string) | The company name associated with the shipping/billing address. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/saas/types-a-b.md#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The company's city or town. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company name associated with the shipping/billing address. | | `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `custom_attributes` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](types-q-s.md#string) | The fax number of the customer. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the company user. | -| `lastname` - [`String!`](types-q-s.md#string) | The last name of the company user. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](types-q-s.md#string) | The company's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `custom_attributes` - [`[AttributeValueInterface]`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The fax number of the customer. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the company user. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The last name of the company user. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The customer's telephone number. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the negotiable quote address. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | +| `selected_shipping_method` - [`SelectedShippingMethod`](/reference/graphql/saas/types-q-s.md#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's telephone number. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Tax/VAT number (for corporate customers). | #### Example @@ -1080,11 +1080,11 @@ Contains a reference document link for a negotiable quote template. "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "abc123", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, "street": ["abc123"], @@ -1106,8 +1106,8 @@ Defines shipping addresses for the negotiable quote. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Text provided by the company user. | #### Example @@ -1129,7 +1129,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/saas/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example @@ -1192,26 +1192,26 @@ Contains details about a negotiable quote template. |------------|-------------| | `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!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was created. | -| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote template was created. | +| `expiration_date` - [`String!`](/reference/graphql/saas/types-q-s.md#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!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](/reference/graphql/saas/types-c-e.md#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](/reference/graphql/saas/types-q-s.md#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](/reference/graphql/saas/types-c-e.md#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!`](types-q-s.md#string) | The first and last name of the sales representative. | +| `sales_rep_name` - [`String!`](/reference/graphql/saas/types-q-s.md#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!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](types-f-i.md#float) | The total number of items in the negotiable quote template. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `updated_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was updated. | +| `status` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The total number of items in the negotiable quote template. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `updated_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote template was updated. | #### Example @@ -1220,15 +1220,15 @@ Contains details about a negotiable quote template. "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "expiration_date": "abc123", + "expiration_date": "xyz789", "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, + "max_order_commitment": 987, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1239,8 +1239,8 @@ Contains details about a negotiable quote template. "status": "xyz789", "template_id": "4", "total_quantity": 123.45, - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } ``` @@ -1254,8 +1254,8 @@ Defines a filter to limit the negotiable quotes to return. | Input Field | Description | |-------------|-------------| -| `state` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | +| `state` - [`FilterEqualTypeInput`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example @@ -1276,49 +1276,49 @@ Contains data for a negotiable quote template in a grid. | Field Name | Description | |------------|-------------| -| `activated_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](types-q-s.md#string) | Company name the quote template is assigned to | -| `created_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was created. | -| `expiration_date` - [`String!`](types-q-s.md#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_ordered_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the last negotiable quote template order was placed. | -| `last_shared_at` - [`String!`](types-q-s.md#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](types-f-i.md#int) | Commitment for minimum orders | -| `name` - [`String!`](types-q-s.md#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](types-f-i.md#int) | The number of orders placed for the negotiable quote template. | -| `prices` - [`CartPrices`](types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | -| `sales_rep_name` - [`String!`](types-q-s.md#string) | The first and last name of the sales representative. | -| `state` - [`String!`](types-q-s.md#string) | State of the negotiable quote template. | -| `status` - [`String!`](types-q-s.md#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](types-q-s.md#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `updated_at` - [`String!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote template was updated. | +| `activated_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Company name the quote template is assigned to | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote template was created. | +| `expiration_date` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_ordered_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the last negotiable quote template order was placed. | +| `last_shared_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Commitment for minimum orders | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of orders placed for the negotiable quote template. | +| `prices` - [`CartPrices`](/reference/graphql/saas/types-c-e.md#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `sales_rep_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first and last name of the sales representative. | +| `state` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | State of the negotiable quote template. | +| `status` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `updated_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote template was updated. | #### Example ```json { - "activated_at": "xyz789", + "activated_at": "abc123", "company_name": "xyz789", - "created_at": "abc123", - "expiration_date": "abc123", - "is_min_max_qty_used": true, + "created_at": "xyz789", + "expiration_date": "xyz789", + "is_min_max_qty_used": false, "last_ordered_at": "abc123", "last_shared_at": "abc123", - "max_order_commitment": 987, - "min_negotiated_grand_total": 123.45, + "max_order_commitment": 123, + "min_negotiated_grand_total": 987.65, "min_order_commitment": 987, "name": "abc123", - "orders_placed": 987, + "orders_placed": 123, "prices": CartPrices, - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "state": "xyz789", "status": "abc123", - "submitted_by": "xyz789", - "template_id": "4", + "submitted_by": "abc123", + "template_id": 4, "uid": 4, "updated_at": "abc123" } @@ -1367,8 +1367,8 @@ Contains details about a change for a negotiable quote template. | `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!`](types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example @@ -1377,7 +1377,7 @@ Contains details about a change for a negotiable quote template. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteTemplateHistoryChanges, - "created_at": "abc123", + "created_at": "xyz789", "uid": "4" } ``` @@ -1392,15 +1392,15 @@ Lists a new status change applied to a negotiable quote template and the previou | Field Name | Description | |------------|-------------| -| `new_status` - [`String!`](types-q-s.md#string) | The updated status. | -| `old_status` - [`String`](types-q-s.md#string) | The previous status. The value will be null for the first history entry in a negotiable quote. | +| `new_status` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The updated status. | +| `old_status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The previous status. The value will be null for the first history entry in a negotiable quote. | #### Example ```json { - "new_status": "xyz789", - "old_status": "xyz789" + "new_status": "abc123", + "old_status": "abc123" } ``` @@ -1432,15 +1432,20 @@ Specifies the updated quantity of an item. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](types-f-i.md#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`](types-f-i.md#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!`](types-f-i.md#float) | The new quantity of the negotiable quote item. | +| `item_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-f-i.md#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} +{ + "item_id": "4", + "max_qty": 987.65, + "min_qty": 123.45, + "quantity": 123.45 +} ``` @@ -1453,17 +1458,17 @@ Defines the reference document link to add to a negotiable quote template. | Input Field | Description | |-------------|-------------| -| `document_identifier` - [`String`](types-q-s.md#string) | The identifier of the reference document. | -| `document_name` - [`String!`](types-q-s.md#string) | The title of the reference document. | -| `link_id` - [`ID`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | -| `reference_document_url` - [`String!`](types-q-s.md#string) | The URL of the reference document. | +| `document_identifier` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The identifier of the reference document. | +| `document_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The title of the reference document. | +| `link_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The URL of the reference document. | #### Example ```json { - "document_identifier": "abc123", - "document_name": "xyz789", + "document_identifier": "xyz789", + "document_name": "abc123", "link_id": 4, "reference_document_url": "abc123" } @@ -1480,8 +1485,8 @@ Defines shipping addresses for the negotiable quote template. | Input Field | Description | |-------------|-------------| | `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](types-q-s.md#string) | Text provided by the company user. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Text provided by the company user. | #### Example @@ -1503,7 +1508,7 @@ Defines the field to use to sort a list of negotiable quotes. | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | +| `sort_direction` - [`SortEnum!`](/reference/graphql/saas/types-q-s.md#sortenum) | Whether to return results in ascending or descending order. | | `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example @@ -1540,9 +1545,9 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quote templates returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/saas/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of negotiable quote templates returned | #### Example @@ -1551,7 +1556,7 @@ Contains a list of negotiable templates that match the specified filter. "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } ``` @@ -1563,7 +1568,7 @@ Contains a list of negotiable templates that match the specified filter. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Possible Types @@ -1574,7 +1579,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1587,12 +1592,12 @@ Contains details about a successful operation on a negotiable quote. | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1605,15 +1610,15 @@ A limited view of a Buyer or Seller in the negotiable quote process. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](types-q-s.md#string) | The buyer's or seller's last name. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The buyer's or seller's last name. | #### Example ```json { - "firstname": "xyz789", - "lastname": "abc123" + "firstname": "abc123", + "lastname": "xyz789" } ``` @@ -1628,9 +1633,9 @@ Contains a list of negotiable that match the specified filter. | Field Name | Description | |------------|-------------| | `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](types-f-i.md#int) | The number of negotiable quotes returned | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](/reference/graphql/saas/types-q-s.md#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of negotiable quotes returned | #### Example @@ -1653,14 +1658,14 @@ Contains an error message when an invalid UID was specified. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | -| `uid` - [`ID!`](types-f-i.md#id) | The specified invalid unique ID of an object. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The returned error message. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The specified invalid unique ID of an object. | #### Example ```json { - "message": "abc123", + "message": "xyz789", "uid": "4" } ``` @@ -1710,16 +1715,16 @@ A custom fee applied to the cart by an out-of-process webhook. | Field Name | Description | |------------|-------------| | `amount` - [`Money!`](#money) | The fee amount in the cart currency. | -| `code` - [`String!`](types-q-s.md#string) | The unique identifier for this fee. | -| `label` - [`String!`](types-q-s.md#string) | The display label for this fee. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique identifier for this fee. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display label for this fee. | #### Example ```json { "amount": Money, - "code": "abc123", - "label": "xyz789" + "code": "xyz789", + "label": "abc123" } ``` @@ -1731,8 +1736,8 @@ A custom fee applied to the cart by an out-of-process webhook. | Field Name | Description | |------------|-------------| -| `backend_integration_url` - [`String!`](types-q-s.md#string) | The backend URL to dispatch requests related to the payment method. | -| `custom_config` - [`[CustomConfigKeyValue]!`](types-c-e.md#customconfigkeyvalue) | Custom config key values. | +| `backend_integration_url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The backend URL to dispatch requests related to the payment method. | +| `custom_config` - [`[CustomConfigKeyValue]!`](/reference/graphql/saas/types-c-e.md#customconfigkeyvalue) | Custom config key values. | #### Example @@ -1753,7 +1758,7 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -1769,11 +1774,11 @@ Specifies the quote template id to open quote template. | Input Field | Description | |-------------|-------------| -| `rangeOperator` - [`RangeOperatorInput`](types-q-s.md#rangeoperatorinput) | | -| `customOperator` - [`CustomOperatorInput`](types-c-e.md#customoperatorinput) | | -| `isOperator` - [`IsOperatorInput`](types-f-i.md#isoperatorinput) | | +| `rangeOperator` - [`RangeOperatorInput`](/reference/graphql/saas/types-q-s.md#rangeoperatorinput) | | +| `customOperator` - [`CustomOperatorInput`](/reference/graphql/saas/types-c-e.md#customoperatorinput) | | +| `isOperator` - [`IsOperatorInput`](/reference/graphql/saas/types-f-i.md#isoperatorinput) | | | `numericOperator` - [`NumericOperatorInput`](#numericoperatorinput) | | -| `stringOperator` - [`StringOperatorInput`](types-q-s.md#stringoperatorinput) | | +| `stringOperator` - [`StringOperatorInput`](/reference/graphql/saas/types-q-s.md#stringoperatorinput) | | #### Example @@ -1797,12 +1802,12 @@ Contains the order ID. | Field Name | Description | |------------|-------------| -| `order_number` - [`String!`](types-q-s.md#string) | The unique ID for an `Order` object. | +| `order_number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID for an `Order` object. | #### Example ```json -{"order_number": "abc123"} +{"order_number": "xyz789"} ``` @@ -1835,43 +1840,43 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `city` - [`String!`](types-q-s.md#string) | The city or town. | -| `company` - [`String`](types-q-s.md#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](types-c-e.md#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `fax` - [`String`](types-q-s.md#string) | The fax number. | -| `firstname` - [`String!`](types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](types-q-s.md#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](types-q-s.md#string) | The state or province name. | -| `region_id` - [`ID`](types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](types-q-s.md#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](types-q-s.md#string) | The telephone number. | -| `vat_id` - [`String`](types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `city` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The city or town. | +| `company` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](/reference/graphql/saas/types-c-e.md#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The fax number. | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The state or province name. | +| `region_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The telephone number. | +| `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "fax": "xyz789", "firstname": "abc123", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", - "region": "abc123", - "region_id": "4", - "street": ["xyz789"], + "region": "xyz789", + "region_id": 4, + "street": ["abc123"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -1883,11 +1888,11 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](types-q-s.md#string) | First name of the customer | -| `lastname` - [`String`](types-q-s.md#string) | Last name of the customer | -| `middlename` - [`String`](types-q-s.md#string) | Middle name of the customer | -| `prefix` - [`String`](types-q-s.md#string) | Prefix of the customer | -| `suffix` - [`String`](types-q-s.md#string) | Suffix of the customer | +| `firstname` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | First name of the customer | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Last name of the customer | +| `middlename` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Middle name of the customer | +| `prefix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Prefix of the customer | +| `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Suffix of the customer | #### Example @@ -1895,9 +1900,9 @@ Contains detailed information about an order's billing and shipping addresses. { "firstname": "xyz789", "lastname": "xyz789", - "middlename": "abc123", - "prefix": "xyz789", - "suffix": "xyz789" + "middlename": "xyz789", + "prefix": "abc123", + "suffix": "abc123" } ``` @@ -1909,29 +1914,29 @@ Contains detailed information about an order's billing and shipping addresses. | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the order item. | #### Example @@ -1939,24 +1944,24 @@ Contains detailed information about an order's billing and shipping addresses. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, + "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_return_requested": 987.65, + "quantity_returned": 123.45, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" @@ -1973,38 +1978,38 @@ Order item details. | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for an `OrderItemInterface` object. | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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`](types-q-s.md#string) | The name of the base product. | +| `product_name` - [`String`](/reference/graphql/saas/types-q-s.md#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!`](types-q-s.md#string) | The SKU of the base product. | -| `product_type` - [`String`](types-q-s.md#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](types-q-s.md#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](types-f-i.md#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](types-f-i.md#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](types-f-i.md#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](types-f-i.md#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](types-f-i.md#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](types-f-i.md#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](types-f-i.md#float) | The number of shipped items. | +| `product_sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the base product. | +| `product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | | `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](types-q-s.md#string) | The status of the order item. | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the order item. | #### Possible Types | OrderItemInterface Types | |----------------| -| [`BundleOrderItem`](types-a-b.md#bundleorderitem) | -| [`ConfigurableOrderItem`](types-c-e.md#configurableorderitem) | -| [`DownloadableOrderItem`](types-c-e.md#downloadableorderitem) | -| [`GiftCardOrderItem`](types-f-i.md#giftcardorderitem) | +| [`BundleOrderItem`](/reference/graphql/saas/types-a-b.md#bundleorderitem) | +| [`ConfigurableOrderItem`](/reference/graphql/saas/types-c-e.md#configurableorderitem) | +| [`DownloadableOrderItem`](/reference/graphql/saas/types-c-e.md#downloadableorderitem) | +| [`GiftCardOrderItem`](/reference/graphql/saas/types-f-i.md#giftcardorderitem) | | [`OrderItem`](#orderitem) | #### Example @@ -2017,19 +2022,19 @@ Order item details. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "abc123", - "product_url_key": "xyz789", + "product_type": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, + "quantity_invoiced": 123.45, "quantity_ordered": 123.45, "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, + "quantity_return_requested": 123.45, "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], @@ -2047,14 +2052,14 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `label` - [`String!`](types-q-s.md#string) | The name of the option. | -| `value` - [`String!`](types-q-s.md#string) | The value of the option. | +| `label` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the option. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The value of the option. | #### Example ```json { - "label": "abc123", + "label": "xyz789", "value": "xyz789" } ``` @@ -2067,8 +2072,8 @@ Represents order item options like selected or entered. | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](types-c-e.md#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](types-f-i.md#fixedproducttax) | | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](/reference/graphql/saas/types-f-i.md#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. | @@ -2108,15 +2113,15 @@ Contains details about the payment method used to pay for the order. | Field Name | Description | |------------|-------------| | `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](types-q-s.md#string) | The label that describes the payment method. | -| `type` - [`String!`](types-q-s.md#string) | The payment method code that indicates how the order was paid for. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The label that describes the payment method. | +| `type` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The payment method code that indicates how the order was paid for. | #### Example ```json { "additional_data": [KeyValue], - "name": "xyz789", + "name": "abc123", "type": "xyz789" } ``` @@ -2131,20 +2136,20 @@ Contains order shipment details. | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](types-q-s.md#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](types-q-s.md#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](types-q-s.md#shipmenttracking) | An array of shipment tracking details. | +| `comments` - [`[SalesCommentItem]`](/reference/graphql/saas/types-q-s.md#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](/reference/graphql/saas/types-q-s.md#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](/reference/graphql/saas/types-q-s.md#shipmenttracking) | An array of shipment tracking details. | #### Example ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [ShipmentItemInterface], - "number": "abc123", + "number": "xyz789", "tracking": [ShipmentTracking] } ``` @@ -2159,7 +2164,7 @@ Input to retrieve an order based on token. | Input Field | Description | |-------------|-------------| -| `token` - [`String!`](types-q-s.md#string) | Order token. | +| `token` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Order token. | #### Example @@ -2178,14 +2183,14 @@ Contains details about the sales total amounts used to calculate the final price | Field Name | Description | |------------|-------------| | `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](types-c-e.md#discount) | The applied discounts to the order. | -| `gift_options` - [`GiftOptionsPrices`](types-f-i.md#giftoptionsprices) | | +| `discounts` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](/reference/graphql/saas/types-f-i.md#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`](types-q-s.md#shippinghandling) | Details about the shipping and handling costs for the order. | +| `shipping_handling` - [`ShippingHandling`](/reference/graphql/saas/types-q-s.md#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]`](types-t-z.md#taxitem) | The order tax details. | +| `taxes` - [`[TaxItem]`](/reference/graphql/saas/types-t-z.md#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. | @@ -2246,8 +2251,8 @@ Defines the payment attribute. | Input Field | Description | |-------------|-------------| -| `key` - [`String!`](types-q-s.md#string) | The code of the attribute. | -| `value` - [`String!`](types-q-s.md#string) | The value of the attribute. | +| `key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The code of the attribute. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The value of the attribute. | #### Example @@ -2268,33 +2273,33 @@ Contains payment fields that are common to all types of payment methods. | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](types-q-s.md#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](types-q-s.md#string) | The name displayed for the payment method | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/saas/types-q-s.md#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name displayed for the payment method | #### Possible Types | PaymentConfigItem Types | |----------------| -| [`ApplePayConfig`](types-a-b.md#applepayconfig) | -| [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | -| [`GooglePayConfig`](types-f-i.md#googlepayconfig) | -| [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | -| [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | +| [`ApplePayConfig`](/reference/graphql/saas/types-a-b.md#applepayconfig) | +| [`FastlaneConfig`](/reference/graphql/saas/types-f-i.md#fastlaneconfig) | +| [`GooglePayConfig`](/reference/graphql/saas/types-f-i.md#googlepayconfig) | +| [`HostedFieldsConfig`](/reference/graphql/saas/types-f-i.md#hostedfieldsconfig) | +| [`SmartButtonsConfig`](/reference/graphql/saas/types-q-s.md#smartbuttonsconfig) | #### Example ```json { - "code": "abc123", - "is_visible": true, - "payment_intent": "abc123", + "code": "xyz789", + "is_visible": false, + "payment_intent": "xyz789", "sdk_params": [SDKParams], "sort_order": "xyz789", - "title": "abc123" + "title": "xyz789" } ``` @@ -2308,11 +2313,11 @@ Retrieves the payment configuration for a given location | Field Name | Description | |------------|-------------| -| `apple_pay` - [`ApplePayConfig`](types-a-b.md#applepayconfig) | ApplePay payment method configuration | -| `fastlane` - [`FastlaneConfig`](types-f-i.md#fastlaneconfig) | Fastlane payment method configuration | -| `google_pay` - [`GooglePayConfig`](types-f-i.md#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | +| `apple_pay` - [`ApplePayConfig`](/reference/graphql/saas/types-a-b.md#applepayconfig) | ApplePay payment method configuration | +| `fastlane` - [`FastlaneConfig`](/reference/graphql/saas/types-f-i.md#fastlaneconfig) | Fastlane payment method configuration | +| `google_pay` - [`GooglePayConfig`](/reference/graphql/saas/types-f-i.md#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](/reference/graphql/saas/types-f-i.md#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](/reference/graphql/saas/types-q-s.md#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example @@ -2360,21 +2365,21 @@ Defines the payment method. | Input Field | Description | |-------------|-------------| | `additional_data` - [`[PaymentAttributeInput]`](#paymentattributeinput) | Additional data related to the payment method. | -| `code` - [`String!`](types-q-s.md#string) | The internal name for the payment method. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](types-f-i.md#fastlanemethodinput) | Required input for fastlane | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](types-t-z.md#vaultmethodinput) | Required input for vault | -| `purchase_order_number` - [`String`](types-q-s.md#string) | The purchase order number. Optional for most payment methods. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The internal name for the payment method. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](/reference/graphql/saas/types-a-b.md#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](/reference/graphql/saas/types-f-i.md#fastlanemethodinput) | Required input for fastlane | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](/reference/graphql/saas/types-f-i.md#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](/reference/graphql/saas/types-f-i.md#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](/reference/graphql/saas/types-q-s.md#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](/reference/graphql/saas/types-t-z.md#vaultmethodinput) | Required input for vault | +| `purchase_order_number` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { "additional_data": [PaymentAttributeInput], - "code": "xyz789", + "code": "abc123", "payment_services_paypal_apple_pay": ApplePayMethodInput, "payment_services_paypal_fastlane": FastlaneMethodInput, "payment_services_paypal_google_pay": GooglePayMethodInput, @@ -2395,10 +2400,10 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `mp_order_id` - [`String`](types-q-s.md#string) | The order ID generated by Payment Services | +| `id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | PayPal order ID | +| `mp_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The order ID generated by Payment Services | | `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](types-q-s.md#string) | The status of the payment order | +| `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The status of the payment order | #### Example @@ -2407,7 +2412,7 @@ Contains the payment order details "id": "xyz789", "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "status": "abc123" } ``` @@ -2419,8 +2424,8 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `code` - [`String`](types-q-s.md#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The payment SDK parameters | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](/reference/graphql/saas/types-q-s.md#sdkparams) | The payment SDK parameters | #### Example @@ -2439,7 +2444,7 @@ Contains the payment order details | Field Name | Description | |------------|-------------| -| `card` - [`Card`](types-c-e.md#card) | Details about the card used on the order | +| `card` - [`Card`](/reference/graphql/saas/types-c-e.md#card) | Details about the card used on the order | #### Example @@ -2457,7 +2462,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](types-c-e.md#cardpaymentsourceinput) | The card payment source information | +| `card` - [`CardPaymentSourceInput!`](/reference/graphql/saas/types-c-e.md#cardpaymentsourceinput) | The card payment source information | #### Example @@ -2475,7 +2480,7 @@ The payment source information | Field Name | Description | |------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](types-c-e.md#cardpaymentsourceoutput) | The card payment source information | +| `card` - [`CardPaymentSourceOutput!`](/reference/graphql/saas/types-c-e.md#cardpaymentsourceoutput) | The card payment source information | #### Example @@ -2493,9 +2498,9 @@ The stored payment method available to the customer. | Field Name | Description | |------------|-------------| -| `details` - [`String`](types-q-s.md#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](types-q-s.md#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](types-q-s.md#string) | The public hash of the token. | +| `details` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The public hash of the token. | | `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example @@ -2538,22 +2543,22 @@ Contains attributes specific to tangible products. | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Possible Types | PhysicalProductInterface Types | |----------------| -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | +| [`BundleProduct`](/reference/graphql/saas/types-a-b.md#bundleproduct) | +| [`ConfigurableProduct`](/reference/graphql/saas/types-c-e.md#configurableproduct) | +| [`GiftCardProduct`](/reference/graphql/saas/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/saas/types-f-i.md#groupedproduct) | +| [`SimpleProduct`](/reference/graphql/saas/types-q-s.md#simpleproduct) | #### Example ```json -{"weight": 123.45} +{"weight": 987.65} ``` @@ -2566,21 +2571,21 @@ Defines Pickup Location information. | Field Name | Description | |------------|-------------| -| `city` - [`String`](types-q-s.md#string) | | -| `contact_name` - [`String`](types-q-s.md#string) | | -| `country_id` - [`String`](types-q-s.md#string) | | -| `description` - [`String`](types-q-s.md#string) | | -| `email` - [`String`](types-q-s.md#string) | | -| `fax` - [`String`](types-q-s.md#string) | | -| `latitude` - [`Float`](types-f-i.md#float) | | -| `longitude` - [`Float`](types-f-i.md#float) | | -| `name` - [`String`](types-q-s.md#string) | | -| `phone` - [`String`](types-q-s.md#string) | | -| `pickup_location_code` - [`String`](types-q-s.md#string) | | -| `postcode` - [`String`](types-q-s.md#string) | | -| `region` - [`String`](types-q-s.md#string) | | -| `region_id` - [`Int`](types-f-i.md#int) | | -| `street` - [`String`](types-q-s.md#string) | | +| `city` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `contact_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `country_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `email` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `fax` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `latitude` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | | +| `longitude` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `phone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `pickup_location_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `postcode` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `region` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `region_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `street` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -2589,18 +2594,18 @@ Defines Pickup Location information. "city": "xyz789", "contact_name": "abc123", "country_id": "xyz789", - "description": "xyz789", + "description": "abc123", "email": "xyz789", - "fax": "abc123", - "latitude": 987.65, - "longitude": 987.65, - "name": "abc123", + "fax": "xyz789", + "latitude": 123.45, + "longitude": 123.45, + "name": "xyz789", "phone": "abc123", "pickup_location_code": "abc123", - "postcode": "xyz789", - "region": "xyz789", + "postcode": "abc123", + "region": "abc123", "region_id": 987, - "street": "xyz789" + "street": "abc123" } ``` @@ -2614,14 +2619,14 @@ PickupLocationFilterInput defines the list of attributes and filters for the sea | Input Field | Description | |-------------|-------------| -| `city` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](types-f-i.md#filtertypeinput) | Filter by street. | +| `city` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](/reference/graphql/saas/types-f-i.md#filtertypeinput) | Filter by street. | #### Example @@ -2648,22 +2653,22 @@ PickupLocationSortInput specifies attribute to use for sorting search results an | Input Field | Description | |-------------|-------------| -| `city` - [`SortEnum`](types-q-s.md#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](types-q-s.md#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](types-q-s.md#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](types-q-s.md#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`](types-q-s.md#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](types-q-s.md#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](types-q-s.md#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](types-q-s.md#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](types-q-s.md#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](types-q-s.md#sortenum) | Id of the region. | -| `street` - [`SortEnum`](types-q-s.md#sortenum) | Street where pickup location is placed. | +| `city` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#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`](/reference/graphql/saas/types-q-s.md#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Id of the region. | +| `street` - [`SortEnum`](/reference/graphql/saas/types-q-s.md#sortenum) | Street where pickup location is placed. | #### Example @@ -2699,8 +2704,8 @@ Top level object returned in a pickup locations search. | Field Name | Description | |------------|-------------| | `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](types-f-i.md#int) | The number of products returned. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The number of products returned. | #### Example @@ -2722,7 +2727,7 @@ Specifies the negotiable quote to convert to an order. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2759,7 +2764,7 @@ An output object that returns the generated order. | Field Name | Description | |------------|-------------| | `errors` - [`[PlaceOrderError]`](#placeordererror) | An array of place negotiable quote order errors. | -| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | +| `order` - [`CustomerOrder`](/reference/graphql/saas/types-c-e.md#customerorder) | Full order information. | #### Example @@ -2781,7 +2786,7 @@ An error encountered while placing an order. | Field Name | Description | |------------|-------------| | `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | #### Example @@ -2822,12 +2827,12 @@ Specifies the purchase order to convert to an order. | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a purchase order. | +| `purchase_order_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a purchase order. | #### Example ```json -{"purchase_order_uid": "4"} +{"purchase_order_uid": 4} ``` @@ -2840,7 +2845,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](types-c-e.md#customerorder) | Placed order. | +| `order` - [`CustomerOrder!`](/reference/graphql/saas/types-c-e.md#customerorder) | Placed order. | #### Example @@ -2858,7 +2863,7 @@ Specifies the quote to be converted to an order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example @@ -2877,7 +2882,7 @@ Contains the results of the request to place an order. | Field Name | Description | |------------|-------------| | `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | -| `orderV2` - [`CustomerOrder`](types-c-e.md#customerorder) | Full order information. | +| `orderV2` - [`CustomerOrder`](/reference/graphql/saas/types-c-e.md#customerorder) | Full order information. | #### Example @@ -2898,12 +2903,12 @@ Specifies the quote to be converted to a purchase order. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -2956,13 +2961,13 @@ Specifies the amount and type of price adjustment. | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](types-f-i.md#float) | The amount of the price adjustment. | -| `code` - [`String`](types-q-s.md#string) | Identifies the type of price adjustment. | +| `amount` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The amount of the price adjustment. | +| `code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Identifies the type of price adjustment. | #### Example ```json -{"amount": 123.45, "code": "xyz789"} +{"amount": 123.45, "code": "abc123"} ``` @@ -2975,9 +2980,9 @@ Can be used to retrieve the main price details in case of bundle product | Field Name | Description | |------------|-------------| -| `discount_percentage` - [`Float`](types-f-i.md#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](types-f-i.md#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](types-f-i.md#float) | The regular price of the main product | +| `discount_percentage` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The regular price of the main product | #### Example @@ -2985,7 +2990,7 @@ Can be used to retrieve the main price details in case of bundle product { "discount_percentage": 987.65, "main_final_price": 123.45, - "main_price": 123.45 + "main_price": 987.65 } ``` @@ -3058,7 +3063,7 @@ Defines whether a bundle product's price is displayed as the lowest possible val | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -3074,7 +3079,7 @@ Defines whether a bundle product's price is displayed as the lowest possible val | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -3090,13 +3095,13 @@ Defines whether a bundle product's price is displayed as the lowest possible val | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | | -| `success` - [`Boolean!`](types-a-b.md#boolean) | | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `success` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | | #### Example ```json -{"message": "abc123", "success": true} +{"message": "xyz789", "success": false} ``` @@ -3109,15 +3114,15 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](types-q-s.md#string) | The display value of the attribute. | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The display value of the attribute. | #### Example ```json { - "code": "abc123", - "value": "abc123" + "code": "xyz789", + "value": "xyz789" } ``` @@ -3129,18 +3134,18 @@ Contains a product attribute code and value. | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](types-q-s.md#string) | Attribute type code. | -| `code` - [`ID!`](types-f-i.md#id) | The attribute code. | -| `url` - [`String!`](types-q-s.md#string) | Public URL to download the file. | -| `value` - [`String!`](types-q-s.md#string) | Stored filename only (e.g. file_xyz.pdf). Use url for download. | +| `attribute_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Attribute type code. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The attribute code. | +| `url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Public URL to download the file. | +| `value` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Stored filename only (e.g. file_xyz.pdf). Use url for download. | #### Example ```json { - "attribute_type": "xyz789", - "code": "4", - "url": "xyz789", + "attribute_type": "abc123", + "code": 4, + "url": "abc123", "value": "abc123" } ``` @@ -3155,8 +3160,8 @@ Product custom attributes | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | Requested custom attributes | +| `errors` - [`[AttributeMetadataError]!`](/reference/graphql/saas/types-a-b.md#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | Requested custom attributes | #### Example @@ -3177,8 +3182,8 @@ Contains the discount applied to a product price. | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](types-f-i.md#float) | The actual value of the discount. | -| `percent_off` - [`Float`](types-f-i.md#float) | The discount expressed a percentage. | +| `amount_off` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The actual value of the discount. | +| `percent_off` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The discount expressed a percentage. | #### Example @@ -3196,10 +3201,10 @@ Contains product image information, including the image URL and label. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL of the product image or video. | #### Example @@ -3208,7 +3213,7 @@ Contains product image information, including the image URL and label. "disabled": true, "label": "xyz789", "position": 123, - "url": "xyz789" + "url": "abc123" } ``` @@ -3239,12 +3244,12 @@ Product Information used for Pickup Locations search. | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](types-q-s.md#string) | Product SKU. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Product SKU. | #### Example ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` @@ -3257,57 +3262,57 @@ Contains fields that are common to all types of products. | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | +| `canonical_url` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](/reference/graphql/saas/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product's country of origin. | | `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | | `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `is_returnable` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | | `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Product stock only x left count | +| `options_container` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | | `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | | `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | +| `special_price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for a product with a special price. | | `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | +| `swatch_image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file name of a swatch image. | | `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | | `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The part of the URL that identifies the product | #### Possible Types | ProductInterface Types | |----------------| -| [`BundleProduct`](types-a-b.md#bundleproduct) | -| [`ConfigurableProduct`](types-c-e.md#configurableproduct) | -| [`DownloadableProduct`](types-c-e.md#downloadableproduct) | -| [`GiftCardProduct`](types-f-i.md#giftcardproduct) | -| [`GroupedProduct`](types-f-i.md#groupedproduct) | -| [`SimpleProduct`](types-q-s.md#simpleproduct) | -| [`VirtualProduct`](types-t-z.md#virtualproduct) | +| [`BundleProduct`](/reference/graphql/saas/types-a-b.md#bundleproduct) | +| [`ConfigurableProduct`](/reference/graphql/saas/types-c-e.md#configurableproduct) | +| [`DownloadableProduct`](/reference/graphql/saas/types-c-e.md#downloadableproduct) | +| [`GiftCardProduct`](/reference/graphql/saas/types-f-i.md#giftcardproduct) | +| [`GroupedProduct`](/reference/graphql/saas/types-f-i.md#groupedproduct) | +| [`SimpleProduct`](/reference/graphql/saas/types-q-s.md#simpleproduct) | +| [`VirtualProduct`](/reference/graphql/saas/types-t-z.md#virtualproduct) | #### Example @@ -3315,7 +3320,7 @@ Contains fields that are common to all types of products. { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -3323,35 +3328,35 @@ Contains fields that are common to all types of products. "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, - "max_sale_qty": 123.45, + "is_returnable": "xyz789", + "manufacturer": 123, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", "min_sale_qty": 123.45, - "name": "abc123", - "new_from_date": "xyz789", + "name": "xyz789", + "new_from_date": "abc123", "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "options_container": "xyz789", + "only_x_left_in_stock": 123.45, + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123" + "url_key": "xyz789" } ``` @@ -3365,20 +3370,20 @@ An implementation of `ProductLinksInterface`. | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The identifier of the linked product. | #### Example ```json { - "link_type": "xyz789", + "link_type": "abc123", "linked_product_sku": "abc123", - "linked_product_type": "xyz789", - "position": 987, + "linked_product_type": "abc123", + "position": 123, "sku": "abc123" } ``` @@ -3393,11 +3398,11 @@ Contains information about linked products, including the link type and product | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](types-q-s.md#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](types-q-s.md#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](types-f-i.md#int) | The position within the list of product links. | -| `sku` - [`String`](types-q-s.md#string) | The identifier of the linked product. | +| `link_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The position within the list of product links. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The identifier of the linked product. | #### Possible Types @@ -3411,7 +3416,7 @@ Contains information about linked products, including the link type and product { "link_type": "xyz789", "linked_product_sku": "abc123", - "linked_product_type": "xyz789", + "linked_product_type": "abc123", "position": 987, "sku": "abc123" } @@ -3427,9 +3432,9 @@ Contains basic information about the image asset. | Field Name | Description | |------------|-------------| -| `asset_id` - [`String`](types-q-s.md#string) | Asset Id. | -| `media_type` - [`String`](types-q-s.md#string) | Must be asset-image. | -| `media_url` - [`String`](types-q-s.md#string) | Asset Image Url. | +| `asset_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Asset Id. | +| `media_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Must be asset-image. | +| `media_url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Asset Image Url. | #### Example @@ -3451,9 +3456,9 @@ Contains basic information about the video asset. | Field Name | Description | |------------|-------------| -| `media_type` - [`String`](types-q-s.md#string) | Must be asset-video. | -| `video_asset_id` - [`String`](types-q-s.md#string) | Asset Id. | -| `video_media_url` - [`String`](types-q-s.md#string) | Asset Video Url. | +| `media_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Must be asset-video. | +| `video_asset_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Asset Id. | +| `video_media_url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Asset Video Url. | #### Example @@ -3475,21 +3480,21 @@ Contains a link to a video file and basic information about the video. | Field Name | Description | |------------|-------------| -| `media_type` - [`String`](types-q-s.md#string) | Must be external-video. | -| `video_description` - [`String`](types-q-s.md#string) | A description of the video. | -| `video_metadata` - [`String`](types-q-s.md#string) | Optional data about the video. | -| `video_provider` - [`String`](types-q-s.md#string) | Describes the video source. | -| `video_title` - [`String`](types-q-s.md#string) | The title of the video. | -| `video_url` - [`String`](types-q-s.md#string) | The URL to the video. | +| `media_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Must be external-video. | +| `video_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A description of the video. | +| `video_metadata` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Optional data about the video. | +| `video_provider` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Describes the video source. | +| `video_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The title of the video. | +| `video_url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL to the video. | #### Example ```json { - "media_type": "abc123", - "video_description": "abc123", + "media_type": "xyz789", + "video_description": "xyz789", "video_metadata": "xyz789", - "video_provider": "xyz789", + "video_provider": "abc123", "video_title": "xyz789", "video_url": "xyz789" } @@ -3507,7 +3512,7 @@ Represents a product price. |------------|-------------| | `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]`](types-f-i.md#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `fixed_product_taxes` - [`[FixedProductTax]`](/reference/graphql/saas/types-f-i.md#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 @@ -3531,8 +3536,8 @@ A single product returned by the query | Field Name | Description | |------------|-------------| -| `applied_query_rule` - [`AppliedQueryRule`](types-a-b.md#appliedqueryrule) | The query rule type that was applied to this product, if any (in preview mode only, returns null otherwise) | -| `highlights` - [`[Highlight]`](types-f-i.md#highlight) | An object that provides highlighted text for matched words | +| `applied_query_rule` - [`AppliedQueryRule`](/reference/graphql/saas/types-a-b.md#appliedqueryrule) | The query rule type that was applied to this product, if any (in preview mode only, returns null otherwise) | +| `highlights` - [`[Highlight]`](/reference/graphql/saas/types-f-i.md#highlight) | An object that provides highlighted text for matched words | | `productView` - [`ProductView`](#productview) | Contains a product view | #### Example @@ -3555,12 +3560,12 @@ Contains the output of a `productSearch` query | Field Name | Description | |------------|-------------| -| `facets` - [`[Aggregation]`](types-a-b.md#aggregation) | Details about the static and dynamic facets relevant to the search | +| `facets` - [`[Aggregation]`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#searchresultpageinfo) | Information for rendering pages of search results | -| `related_terms` - [`[String]`](types-q-s.md#string) | An array of strings that might include merchant-defined synonyms | -| `suggestions` - [`[String]`](types-q-s.md#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`](types-f-i.md#int) | The total number of products returned that matched the query | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Information for rendering pages of search results | +| `related_terms` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | An array of strings that might include merchant-defined synonyms | +| `suggestions` - [`[String]`](/reference/graphql/saas/types-q-s.md#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`](/reference/graphql/saas/types-f-i.md#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 @@ -3587,13 +3592,13 @@ The product attribute to sort on | Input Field | Description | |-------------|-------------| -| `attribute` - [`String!`](types-q-s.md#string) | The attribute code of a product attribute | -| `direction` - [`SortEnum!`](types-q-s.md#sortenum) | ASC (ascending) or DESC (descending) | +| `attribute` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The attribute code of a product attribute | +| `direction` - [`SortEnum!`](/reference/graphql/saas/types-q-s.md#sortenum) | ASC (ascending) or DESC (descending) | #### Example ```json -{"attribute": "abc123", "direction": "ASC"} +{"attribute": "xyz789", "direction": "ASC"} ``` @@ -3606,8 +3611,8 @@ Structured warning with code and message for easier client handling | Field Name | Description | |------------|-------------| -| `code` - [`String!`](types-q-s.md#string) | Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH) | -| `message` - [`String!`](types-q-s.md#string) | Human-readable message describing the warning | +| `code` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH) | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Human-readable message describing the warning | #### Example @@ -3647,19 +3652,19 @@ Contains information about a product video. | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](types-q-s.md#string) | The label of the product image or video. | -| `position` - [`Int`](types-f-i.md#int) | The media item's position after it has been sorted. | -| `url` - [`String`](types-q-s.md#string) | The URL of the product image or video. | +| `disabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The label of the product image or video. | +| `position` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The media item's position after it has been sorted. | +| `url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The URL of the product image or video. | | `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json { - "disabled": true, - "label": "abc123", - "position": 987, + "disabled": false, + "label": "xyz789", + "position": 123, "url": "abc123", "video_content": ProductMediaGalleryEntriesVideoContent } @@ -3675,35 +3680,35 @@ Defines the product fields available to the SimpleProductView and ComplexProduct | Field Name | Description | |------------|-------------| -| `addToCartAllowed` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | -| `inStock` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | -| `lowStock` - [`Boolean`](types-a-b.md#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.)* | +| `addToCartAllowed` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-q-s.md#string) | The detailed description of the product. | -| `id` - [`ID!`](types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The detailed description of the product. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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`](types-c-e.md#datetime) | Date and time when the product was last updated. | -| `metaDescription` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings. | -| `metaKeyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `metaTitle` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](types-q-s.md#string) | Product title for search results listings. | -| `shortDescription` - [`String`](types-q-s.md#string) | A summary of the product for search results listings. | +| `lastModifiedAt` - [`DateTime`](/reference/graphql/saas/types-c-e.md#datetime) | Date and time when the product was last updated. | +| `metaDescription` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings. | +| `metaKeyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `metaTitle` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Product title for search results listings. | +| `shortDescription` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | A unique code used for identification of a product. | -| `externalId` - [`String`](types-q-s.md#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | -| `url` - [`String`](types-q-s.md#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | -| `urlKey` - [`String`](types-q-s.md#string) | The URL key of the product. This is a unique identifier for the product that is used to create the product's URL. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A unique code used for identification of a product. | +| `externalId` - [`String`](/reference/graphql/saas/types-q-s.md#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | +| `url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | +| `urlKey` - [`String`](/reference/graphql/saas/types-q-s.md#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`](types-q-s.md#string) | Indicates if the product was retrieved from the primary or the backup query | -| `visibility` - [`String`](types-q-s.md#string) | Visibility setting of the product | +| `queryType` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates if the product was retrieved from the primary or the backup query | +| `visibility` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Visibility setting of the product | #### Possible Types | ProductView Types | |----------------| -| [`ComplexProductView`](types-c-e.md#complexproductview) | -| [`SimpleProductView`](types-q-s.md#simpleproductview) | +| [`ComplexProductView`](/reference/graphql/saas/types-c-e.md#complexproductview) | +| [`SimpleProductView`](/reference/graphql/saas/types-q-s.md#simpleproductview) | #### Example @@ -3711,23 +3716,23 @@ Defines the product fields available to the SimpleProductView and ComplexProduct { "addToCartAllowed": true, "inStock": false, - "lowStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], "description": "abc123", - "id": 4, + "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", - "metaTitle": "abc123", + "metaDescription": "abc123", + "metaKeyword": "abc123", + "metaTitle": "xyz789", "name": "abc123", "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "abc123", - "externalId": "abc123", + "sku": "xyz789", + "externalId": "xyz789", "url": "xyz789", - "urlKey": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], "queryType": "abc123", "visibility": "xyz789" @@ -3744,10 +3749,10 @@ A container for customer-defined attributes that are displayed the storefront. | Field Name | Description | |------------|-------------| -| `label` - [`String`](types-q-s.md#string) | Label of the attribute. | -| `name` - [`String!`](types-q-s.md#string) | Name of an attribute code. For example, `color`, `size` or `material` | -| `roles` - [`[String]`](types-q-s.md#string) | Roles designated for an attribute on the storefront. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | -| `value` - [`JSON`](types-f-i.md#json) | Attribute value, arbitrary of type. For example, `red`, `blue` or `green` | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Label of the attribute. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Name of an attribute code. For example, `color`, `size` or `material` | +| `roles` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | Roles designated for an attribute on the storefront. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | +| `value` - [`JSON`](/reference/graphql/saas/types-f-i.md#json) | Attribute value, arbitrary of type. For example, `red`, `blue` or `green` | #### Example @@ -3755,7 +3760,7 @@ A container for customer-defined attributes that are displayed the storefront. { "label": "xyz789", "name": "xyz789", - "roles": ["abc123"], + "roles": ["xyz789"], "value": {} } ``` @@ -3957,17 +3962,17 @@ Contains details about a product image. | Field Name | Description | |------------|-------------| -| `label` - [`String`](types-q-s.md#string) | The display label of the product image. For example, `Main Image`, `Small Image` or `Thumbnail Image` | -| `roles` - [`[String]`](types-q-s.md#string) | A list that describes how the image is used. Can be `image`, `small_image` or `thumbnail` | -| `url` - [`String!`](types-q-s.md#string) | The URL to the product image. For example, `https://example.com/image.jpg`. | +| `label` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display label of the product image. For example, `Main Image`, `Small Image` or `Thumbnail Image` | +| `roles` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | A list that describes how the image is used. Can be `image`, `small_image` or `thumbnail` | +| `url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The URL to the product image. For example, `https://example.com/image.jpg`. | #### Example ```json { "label": "xyz789", - "roles": ["abc123"], - "url": "abc123" + "roles": ["xyz789"], + "url": "xyz789" } ``` @@ -3981,16 +3986,16 @@ Product options provide a way to configure products by making selections of part | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `required` - [`Boolean`](types-a-b.md#boolean) | Indicates whether this input option is required. | -| `type` - [`String`](types-q-s.md#string) | The type of data entry. For example, `text`, `number` or `date` | -| `markupAmount` - [`Float`](types-f-i.md#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`](types-q-s.md#string) | SKU suffix to add to the product. For example, `-red`, `-blue` or `-green` | -| `sortOrder` - [`Int`](types-f-i.md#int) | Sort order for the input option. For example, `1` for the first input option, `2` for the second input option. | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `required` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether this input option is required. | +| `type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The type of data entry. For example, `text`, `number` or `date` | +| `markupAmount` - [`Float`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-q-s.md#string) | SKU suffix to add to the product. For example, `-red`, `-blue` or `-green` | +| `sortOrder` - [`Int`](/reference/graphql/saas/types-f-i.md#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`](types-q-s.md#string) | The file extensions allowed for the image. For example, `jpg`, `png`, `gif`, or `svg` | +| `fileExtensions` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file extensions allowed for the image. For example, `jpg`, `png`, `gif`, or `svg` | #### Example @@ -3998,9 +4003,9 @@ Product options provide a way to configure products by making selections of part { "id": 4, "title": "abc123", - "required": false, - "type": "abc123", - "markupAmount": 987.65, + "required": true, + "type": "xyz789", + "markupAmount": 123.45, "suffix": "abc123", "sortOrder": 987, "range": ProductViewInputOptionRange, @@ -4019,13 +4024,13 @@ Dimensions of the image associated with the input option. | Field Name | Description | |------------|-------------| -| `width` - [`Int`](types-f-i.md#int) | The width of the image in pixels. For example, `100` for a 100px width. | -| `height` - [`Int`](types-f-i.md#int) | The height of the image, in pixels. For example, `100` for a 100px height. | +| `width` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The width of the image in pixels. For example, `100` for a 100px width. | +| `height` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The height of the image, in pixels. For example, `100` for a 100px height. | #### Example ```json -{"width": 123, "height": 123} +{"width": 123, "height": 987} ``` @@ -4038,13 +4043,13 @@ Lists the value range associated with a `ProductViewInputOption`. For example, i | Field Name | Description | |------------|-------------| -| `from` - [`Float`](types-f-i.md#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`](types-f-i.md#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. | +| `from` - [`Float`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-f-i.md#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 -{"from": 987.65, "to": 123.45} +{"from": 123.45, "to": 987.65} ``` @@ -4058,7 +4063,7 @@ The product link type. Contains details about product links for related products | Field Name | Description | |------------|-------------| | `product` - [`ProductView!`](#productview) | Contains the details of the product found in the link. | -| `linkTypes` - [`[String!]!`](types-q-s.md#string) | Stores the types of the links with this product. | +| `linkTypes` - [`[String!]!`](/reference/graphql/saas/types-q-s.md#string) | Stores the types of the links with this product. | #### Example @@ -4080,12 +4085,12 @@ Defines a monetary value, including a numeric value and a currency code. | Field Name | Description | |------------|-------------| | `currency` - [`ProductViewCurrency`](#productviewcurrency) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](types-f-i.md#float) | A number expressing a monetary value. | +| `value` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | A number expressing a monetary value. | #### Example ```json -{"currency": "AED", "value": 987.65} +{"currency": "AED", "value": 123.45} ``` @@ -4098,20 +4103,20 @@ Product options provide a way to configure products by making selections of part | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The ID of the option. For example, `123` for the first option, `456` for the second option. | -| `multi` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether the option must be selected. | -| `title` - [`String`](types-q-s.md#string) | The display name of the option. For example, `Color`, `Size` or `Material` | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of the option. For example, `123` for the first option, `456` for the second option. | +| `multi` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option must be selected. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#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 { - "id": 4, + "id": "4", "multi": false, "required": false, - "title": "abc123", + "title": "xyz789", "values": [ProductViewOptionValue] } ``` @@ -4126,9 +4131,9 @@ Defines the product fields available to the ProductViewOptionValueProduct and Pr | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. | -| `title` - [`String`](types-q-s.md#string) | The display name of the option value. | -| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product has reached the out-of-stock threshold. | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of an option value. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the option value. | +| `inStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the remaining quantity of the product has reached the out-of-stock threshold. | #### Possible Types @@ -4142,9 +4147,9 @@ Defines the product fields available to the ProductViewOptionValueProduct and Pr ```json { - "id": "4", + "id": 4, "title": "xyz789", - "inStock": false + "inStock": true } ``` @@ -4158,16 +4163,16 @@ An implementation of ProductViewOptionValue for configuration values. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `inStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json { "id": 4, - "title": "abc123", + "title": "xyz789", "inStock": false } ``` @@ -4182,13 +4187,13 @@ An implementation of ProductViewOptionValue that adds details about a simple pro | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `isDefault` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the option value is the default. | -| `product` - [`SimpleProductView`](types-q-s.md#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`](types-f-i.md#float) | Default quantity of an option value. | -| `canEditQuantity` - [`Boolean`](types-a-b.md#boolean) | Indicates if the quantity of the option value can be edited. | -| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `isDefault` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the option value is the default. | +| `product` - [`SimpleProductView`](/reference/graphql/saas/types-q-s.md#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`](/reference/graphql/saas/types-f-i.md#float) | Default quantity of an option value. | +| `canEditQuantity` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates if the quantity of the option value can be edited. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `inStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example @@ -4197,8 +4202,8 @@ An implementation of ProductViewOptionValue that adds details about a simple pro "id": "4", "isDefault": false, "product": SimpleProductView, - "quantity": 123.45, - "canEditQuantity": true, + "quantity": 987.65, + "canEditQuantity": false, "title": "abc123", "inStock": true } @@ -4214,21 +4219,21 @@ An implementation of ProductViewOptionValueSwatch for swatches. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `title` - [`String`](types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `type` - [`SwatchType`](types-q-s.md#swatchtype) | Indicates the type of the swatch. | -| `value` - [`String`](types-q-s.md#string) | The value of the swatch depending on the type of the swatch. | -| `inStock` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `type` - [`SwatchType`](/reference/graphql/saas/types-q-s.md#swatchtype) | Indicates the type of the swatch. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value of the swatch depending on the type of the swatch. | +| `inStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json { - "id": "4", + "id": 4, "title": "abc123", "type": "TEXT", "value": "xyz789", - "inStock": false + "inStock": true } ``` @@ -4245,7 +4250,7 @@ Base product price view. Contains the final price after discounts, the regular p | `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]`](types-q-s.md#string) | Price roles, stating if the price should be visible or hidden. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | +| `roles` - [`[String]`](/reference/graphql/saas/types-q-s.md#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 @@ -4307,7 +4312,7 @@ Minimum quantity (inclusive) required to activate this tier price. For example, | Field Name | Description | |------------|-------------| -| `in` - [`[Float]`](types-f-i.md#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. | +| `in` - [`[Float]`](/reference/graphql/saas/types-f-i.md#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 @@ -4347,8 +4352,8 @@ Minimum quantity (inclusive) required to activate this tier price. For example, | Field Name | Description | |------------|-------------| -| `gte` - [`Float`](types-f-i.md#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`](types-f-i.md#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. | +| `gte` - [`Float`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-f-i.md#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 @@ -4366,7 +4371,7 @@ Represents a product variant. | Field Name | Description | |------------|-------------| -| `selections` - [`[String!]`](types-q-s.md#string) | List of option values that make up the variant. For example, `red`, `blue` or `green` | +| `selections` - [`[String!]`](/reference/graphql/saas/types-q-s.md#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 @@ -4389,7 +4394,7 @@ Represents the results of a product variant search. | Field Name | Description | |------------|-------------| | `variants` - [`[ProductViewVariant]!`](#productviewvariant) | List of product variants. For example, a variant with a selection of `red`, `blue` or `green` | -| `cursor` - [`String`](types-q-s.md#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | +| `cursor` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | #### Example @@ -4411,9 +4416,9 @@ Contains details about a product video. For example, a video of the product bein | Field Name | Description | |------------|-------------| | `preview` - [`ProductViewImage`](#productviewimage) | Preview image for the video. For example, a screenshot of the video. | -| `url` - [`String!`](types-q-s.md#string) | The URL to the product video. For example, `https://example.com/video.mp4` or `https://example.com/video.webm` | -| `description` - [`String`](types-q-s.md#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`](types-q-s.md#string) | The title of the product video. For example, `Product Video` or `Product Assembly Video` | +| `url` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The URL to the product video. For example, `https://example.com/video.mp4` or `https://example.com/video.webm` | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#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`](/reference/graphql/saas/types-q-s.md#string) | The title of the product video. For example, `Product Video` or `Product Assembly Video` | #### Example @@ -4421,8 +4426,8 @@ Contains details about a product video. For example, a video of the product bein { "preview": ProductViewImage, "url": "abc123", - "description": "xyz789", - "title": "xyz789" + "description": "abc123", + "title": "abc123" } ``` @@ -4436,15 +4441,15 @@ User purchase history | Input Field | Description | |-------------|-------------| -| `date` - [`DateTime`](types-c-e.md#datetime) | | -| `items` - [`[String]`](types-q-s.md#string) | | +| `date` - [`DateTime`](/reference/graphql/saas/types-c-e.md#datetime) | | +| `items` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | | #### Example ```json { "date": "2007-12-03T10:15:30Z", - "items": ["xyz789"] + "items": ["abc123"] } ``` @@ -4461,15 +4466,15 @@ Contains details about a purchase order. | `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!`](types-q-s.md#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](types-c-e.md#customer) | The company user who created the purchase order. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](/reference/graphql/saas/types-c-e.md#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!`](types-q-s.md#string) | The purchase order number. | -| `order` - [`CustomerOrder`](types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](types-c-e.md#cart) | The quote related to the purchase order. | +| `number` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The purchase order number. | +| `order` - [`CustomerOrder`](/reference/graphql/saas/types-c-e.md#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](/reference/graphql/saas/types-c-e.md#cart) | The quote related to the purchase order. | | `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order was last updated. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the purchase order was last updated. | #### Example @@ -4520,13 +4525,13 @@ Contains details about a failed action. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The returned error message. | | `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{"message": "xyz789", "type": "NOT_FOUND"} ``` @@ -4539,18 +4544,18 @@ Contains details about a single event in the approval flow of the purchase order | Field Name | Description | |------------|-------------| -| `message` - [`String`](types-q-s.md#string) | A formatted message. | -| `name` - [`String`](types-q-s.md#string) | The approver name. | -| `role` - [`String`](types-q-s.md#string) | The approver role. | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A formatted message. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The approver name. | +| `role` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The approver role. | | `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](types-q-s.md#string) | The date and time the event was updated. | +| `updated_at` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The date and time the event was updated. | #### Example ```json { - "message": "abc123", - "name": "abc123", + "message": "xyz789", + "name": "xyz789", "role": "abc123", "status": "PENDING", "updated_at": "xyz789" @@ -4585,16 +4590,16 @@ Contains details about a purchase order approval rule. | Field Name | Description | |------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](types-c-e.md#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `applies_to_roles` - [`[CompanyRole]!`](/reference/graphql/saas/types-c-e.md#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](/reference/graphql/saas/types-c-e.md#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!`](types-q-s.md#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](types-q-s.md#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The name of the purchase order approval rule. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the purchase order approval rule. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](types-q-s.md#string) | The date the purchase order rule was last updated. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date the purchase order rule was last updated. | #### Example @@ -4605,11 +4610,11 @@ Contains details about a purchase order approval rule. "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "xyz789", - "description": "abc123", - "name": "xyz789", + "description": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } ``` @@ -4694,12 +4699,12 @@ Contains approval rule condition details, including the quantity to be evaluated |------------|-------------| | `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`](types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | +| `quantity` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} ``` @@ -4712,22 +4717,22 @@ Defines a new purchase order approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]!`](types-f-i.md#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]!`](types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](types-q-s.md#string) | The purchase order approval rule name. | +| `applies_to` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#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]!`](/reference/graphql/saas/types-f-i.md#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](/reference/graphql/saas/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The purchase order approval rule name. | | `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "applies_to": [4], + "applies_to": ["4"], "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", - "name": "abc123", + "name": "xyz789", "status": "ENABLED" } ``` @@ -4742,9 +4747,9 @@ Contains metadata that can be used to render rule edit forms. | Field Name | Description | |------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](types-a-b.md#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]!`](types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | +| `available_applies_to` - [`[CompanyRole]!`](/reference/graphql/saas/types-c-e.md#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](/reference/graphql/saas/types-a-b.md#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]!`](/reference/graphql/saas/types-c-e.md#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example @@ -4802,8 +4807,8 @@ Contains the approval rules that the customer can see. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The total number of purchase order approval rules visible to the customer. | #### Example @@ -4825,10 +4830,10 @@ Contains details about a comment. | Field Name | Description | |------------|-------------| -| `author` - [`Customer`](types-c-e.md#customer) | The user who left the comment. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the comment was created. | -| `text` - [`String!`](types-q-s.md#string) | The text of the comment. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the comment. | +| `author` - [`Customer`](/reference/graphql/saas/types-c-e.md#customer) | The user who left the comment. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time when the comment was created. | +| `text` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The text of the comment. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | A unique identifier of the comment. | #### Example @@ -4871,19 +4876,19 @@ Contains details about a status change. | Field Name | Description | |------------|-------------| -| `activity` - [`String!`](types-q-s.md#string) | The activity type of the event. | -| `created_at` - [`String!`](types-q-s.md#string) | The date and time when the event happened. | -| `message` - [`String!`](types-q-s.md#string) | The message representation of the event. | -| `uid` - [`ID!`](types-f-i.md#id) | A unique identifier of the purchase order history item. | +| `activity` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The activity type of the event. | +| `created_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time when the event happened. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The message representation of the event. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "activity": "xyz789", + "activity": "abc123", "created_at": "xyz789", - "message": "abc123", - "uid": 4 + "message": "xyz789", + "uid": "4" } ``` @@ -4898,7 +4903,7 @@ Contains details about approval roles applied to the purchase order and status c | Field Name | Description | |------------|-------------| | `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](types-q-s.md#string) | The name of the applied rule. | +| `rule_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the applied rule. | #### Example @@ -4944,8 +4949,8 @@ Contains a list of purchase orders. | Field Name | Description | |------------|-------------| | `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Total number of purchase orders found matching the search criteria. | #### Example @@ -4967,12 +4972,12 @@ Defines which purchase orders to act on. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of purchase order UIDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of purchase order UIDs. | #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -5007,10 +5012,10 @@ Defines the criteria to use to filter the list of purchase orders. | Input Field | Description | |-------------|-------------| -| `company_purchase_orders` - [`Boolean`](types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `my_approvals` - [`Boolean`](types-a-b.md#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`](types-a-b.md#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `company_purchase_orders` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](/reference/graphql/saas/types-f-i.md#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `my_approvals` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-a-b.md#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 @@ -5019,8 +5024,8 @@ Defines the criteria to use to filter the list of purchase orders. { "company_purchase_orders": false, "created_date": FilterRangeTypeInput, - "my_approvals": false, - "require_my_approval": false, + "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 index 890d6334d..507c08397 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md @@ -7,13 +7,13 @@ | 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!]`](types-t-z.md#viewhistoryinput) | User view history with timestamp | +| `userViewHistory` - [`[ViewHistoryInput!]`](/reference/graphql/saas/types-t-z.md#viewhistoryinput) | User view history with timestamp | #### Example ```json { - "customerGroup": "xyz789", + "customerGroup": "abc123", "userViewHistory": [ViewHistoryInput] } ``` @@ -48,7 +48,7 @@ Sets quote template expiration date. | Input Field | Description | |-------------|-------------| | `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -69,10 +69,10 @@ Sets quote item note. | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | -| `item_uid` - [`ID`](types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `item_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | +| `item_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `CartLineItem` object. | | `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `templateId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -80,7 +80,7 @@ Sets quote item note. { "item_id": "4", "item_uid": "4", - "note": "abc123", + "note": "xyz789", "templateId": "4" } ``` @@ -102,7 +102,7 @@ Contains a notification message for a negotiable quote template. ```json { - "message": "abc123", + "message": "xyz789", "type": "xyz789" } ``` @@ -117,19 +117,19 @@ For use on numeric product fields | Field Name | Description | |------------|-------------| -| `count` - [`Int!`](types-f-i.md#int) | The number of items in the bucket | -| `from` - [`Float!`](types-f-i.md#float) | The minimum amount in a price range | +| `count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of items in the bucket | +| `from` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The minimum amount in a price range | | `title` - [`String!`](#string) | The display text defining the price range | -| `to` - [`Float`](types-f-i.md#float) | The maximum amount in a price range | +| `to` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The maximum amount in a price range | #### Example ```json { "count": 987, - "from": 123.45, - "title": "xyz789", - "to": 987.65 + "from": 987.65, + "title": "abc123", + "to": 123.45 } ``` @@ -177,8 +177,8 @@ For use on numeric product fields | Input Field | Description | |-------------|-------------| -| `from` - [`Float`](types-f-i.md#float) | | -| `to` - [`Float`](types-f-i.md#float) | | +| `from` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | | +| `to` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | | #### Example @@ -195,14 +195,14 @@ For use on numeric product fields | Field Name | Description | |------------|-------------| | `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | +| `is_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether reCaptcha type is enabled | #### Example ```json { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } ``` @@ -218,7 +218,7 @@ Contains reCAPTCHA form configuration details. |------------|-------------| | `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`](types-f-i.md#float) | The minimum score that identifies a user interaction as a potential risk. | +| `minimum_score` - [`Float`](/reference/graphql/saas/types-f-i.md#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. | @@ -229,14 +229,14 @@ Contains reCAPTCHA form configuration details. ```json { - "badge_position": "abc123", + "badge_position": "xyz789", "language_code": "abc123", - "minimum_score": 123.45, + "minimum_score": 987.65, "re_captcha_type": "INVISIBLE", "technical_failure_message": "xyz789", "theme": "xyz789", "validation_failure_message": "abc123", - "website_key": "abc123" + "website_key": "xyz789" } ``` @@ -253,9 +253,9 @@ Contains reCAPTCHA V3-Invisible configuration details. | `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!`](types-a-b.md#boolean) | Return whether recaptcha is enabled or not | +| `is_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](types-f-i.md#float) | The minimum score that identifies a user interaction as a potential risk. | +| `minimum_score` - [`Float!`](/reference/graphql/saas/types-f-i.md#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. | @@ -263,13 +263,13 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { - "badge_position": "abc123", + "badge_position": "xyz789", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": false, + "is_enabled": true, "language_code": "abc123", - "minimum_score": 123.45, - "theme": "abc123", + "minimum_score": 987.65, + "theme": "xyz789", "website_key": "xyz789" } ``` @@ -286,7 +286,7 @@ Contains reCAPTCHA configuration for a specific form type. |------------|-------------| | `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type. | | `form_type` - [`ReCaptchaFormEnum!`](#recaptchaformenum) | The form type identifier. | -| `is_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether reCaptcha is enabled for this form type. | +| `is_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether reCaptcha is enabled for this form type. | #### Example @@ -353,11 +353,11 @@ Recommendation Unit containing product and other details | Field Name | Description | |------------|-------------| -| `displayOrder` - [`Int`](types-f-i.md#int) | Order in which recommendation units are displayed | +| `displayOrder` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Order in which recommendation units are displayed | | `pageType` - [`String`](#string) | Page type | -| `productsView` - [`[ProductView]`](types-k-p.md#productview) | List of product view | +| `productsView` - [`[ProductView]`](/reference/graphql/saas/types-k-p.md#productview) | List of product view | | `storefrontLabel` - [`String`](#string) | Storefront label to be displayed on the storefront | -| `totalProducts` - [`Int`](types-f-i.md#int) | Total products returned in recommedations | +| `totalProducts` - [`Int`](/reference/graphql/saas/types-f-i.md#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 | @@ -367,13 +367,13 @@ Recommendation Unit containing product and other details ```json { - "displayOrder": 123, - "pageType": "abc123", + "displayOrder": 987, + "pageType": "xyz789", "productsView": [ProductView], "storefrontLabel": "xyz789", "totalProducts": 987, "typeId": "abc123", - "unitId": "xyz789", + "unitId": "abc123", "unitName": "abc123", "userError": "xyz789" } @@ -390,7 +390,7 @@ Recommendations response | Field Name | Description | |------------|-------------| | `results` - [`[RecommendationUnit]`](#recommendationunit) | List of rec units with products recommended | -| `totalResults` - [`Int`](types-f-i.md#int) | total number of rec units for which recommendations are returned | +| `totalResults` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | total number of rec units for which recommendations are returned | #### Example @@ -407,16 +407,16 @@ Recommendations response | Field Name | Description | |------------|-------------| | `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](types-f-i.md#int) | The unique ID for a `Region` object. | +| `id` - [`Int`](/reference/graphql/saas/types-f-i.md#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" + "code": "xyz789", + "id": 987, + "name": "abc123" } ``` @@ -435,7 +435,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -448,7 +448,7 @@ Contains details about the cart after removing a coupon. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](types-c-e.md#cart) | The cart after removing a coupon. | +| `cart` - [`Cart`](/reference/graphql/saas/types-c-e.md#cart) | The cart after removing a coupon. | #### Example @@ -474,7 +474,7 @@ Remove coupons from the cart. ```json { "cart_id": "abc123", - "coupon_codes": ["abc123"] + "coupon_codes": ["xyz789"] } ``` @@ -495,7 +495,7 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "gift_card_code": "xyz789" } ``` @@ -510,7 +510,7 @@ Defines the possible output for the `removeGiftCardFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -528,7 +528,7 @@ Contains the results of a request to remove an item from a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after removing items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The gift registry after removing items. | #### Example @@ -546,12 +546,12 @@ Contains the results of a request to delete a gift registry. | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | +| `success` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the gift registry was successfully deleted. | #### Example ```json -{"success": false} +{"success": true} ``` @@ -564,7 +564,7 @@ Contains the results of a request to delete a registrant. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after deleting registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The gift registry after deleting registrants. | #### Example @@ -583,15 +583,12 @@ Specifies which items to remove from the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_uid` - [`ID`](types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `cart_item_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json -{ - "cart_id": "xyz789", - "cart_item_uid": "4" -} +{"cart_id": "xyz789", "cart_item_uid": 4} ``` @@ -604,7 +601,7 @@ Contains details about the cart after removing an item. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after removing an item. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after removing an item. | #### Example @@ -622,13 +619,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_item_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"quote_item_uids": ["4"], "quote_uid": 4} +{"quote_item_uids": [4], "quote_uid": 4} ``` @@ -641,7 +638,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after removing items. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after removing items. | #### Example @@ -659,13 +656,13 @@ Defines the items to remove from the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `item_uids` - [`[ID]!`](types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `item_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"item_uids": [4], "template_id": 4} +{"item_uids": ["4"], "template_id": 4} ``` @@ -678,13 +675,16 @@ Defines which products to remove from a compare list. | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](types-f-i.md#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique identifier of the compare list to modify. | +| `products` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique identifier of the compare list to modify. | #### Example ```json -{"products": [4], "uid": 4} +{ + "products": ["4"], + "uid": "4" +} ``` @@ -697,8 +697,8 @@ Contains the customer's wish list and any errors encountered. | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | +| `user_errors` - [`[WishListUserInputError]!`](/reference/graphql/saas/types-t-z.md#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](/reference/graphql/saas/types-t-z.md#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example @@ -719,12 +719,12 @@ Defines the tracking information to delete. | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | +| `return_shipping_tracking_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example ```json -{"return_shipping_tracking_uid": 4} +{"return_shipping_tracking_uid": "4"} ``` @@ -755,7 +755,7 @@ Contains the customer cart. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The customer cart after reward points are removed. | #### Example @@ -778,7 +778,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -791,7 +791,7 @@ Defines the possible output for the `removeStoreCreditFromCart` mutation. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The contents of the specified shopping cart. | #### Example @@ -811,13 +811,13 @@ Sets new name for a negotiable quote. |-------------|-------------| | `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!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | #### Example ```json { - "quote_comment": "abc123", + "quote_comment": "xyz789", "quote_name": "xyz789", "quote_uid": "4" } @@ -833,7 +833,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after updating the name. | #### Example @@ -851,8 +851,8 @@ Contains the cart and any errors after adding products. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](/reference/graphql/saas/types-c-e.md#checkoutuserinputerror) | An array of reordering errors. | #### Example @@ -882,10 +882,10 @@ Contains information needed to start a return request. ```json { - "comment_text": "abc123", - "contact_email": "abc123", + "comment_text": "xyz789", + "contact_email": "xyz789", "items": [RequestReturnItemInput], - "token": "xyz789" + "token": "abc123" } ``` @@ -899,9 +899,9 @@ Defines properties of a negotiable quote request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](types-a-b.md#boolean) | Flag indicating if quote is draft or not. | +| `cart_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](/reference/graphql/saas/types-k-p.md#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Flag indicating if quote is draft or not. | | `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | #### Example @@ -910,7 +910,7 @@ Defines properties of a negotiable quote request. { "cart_id": 4, "comment": NegotiableQuoteCommentInput, - "is_draft": true, + "is_draft": false, "quote_name": "xyz789" } ``` @@ -925,7 +925,7 @@ Contains the `NegotiableQuote` object generated when a buyer requests a negotiab | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | Details about the negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | Details about the negotiable quote. | #### Example @@ -943,7 +943,7 @@ Defines properties of a negotiable quote template request. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The cart ID of the quote to create the new negotiable quote template from. | #### Example @@ -964,14 +964,14 @@ Contains information needed to start a return request. | `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!`](types-f-i.md#id) | The unique ID for a `Order` object. | +| `order_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Order` object. | #### Example ```json { - "comment_text": "xyz789", - "contact_email": "xyz789", + "comment_text": "abc123", + "contact_email": "abc123", "items": [RequestReturnItemInput], "order_uid": 4 } @@ -987,9 +987,9 @@ Contains details about an item to be returned. | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](types-f-i.md#float) | The quantity of the item to be returned. | +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](/reference/graphql/saas/types-c-e.md#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](/reference/graphql/saas/types-f-i.md#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 @@ -999,7 +999,7 @@ Contains details about an item to be returned. "entered_custom_attributes": [ EnteredCustomAttributeInput ], - "order_item_uid": "4", + "order_item_uid": 4, "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput @@ -1041,9 +1041,9 @@ Defines the contents of a requisition list. |------------|-------------| | `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!`](types-f-i.md#int) | The number of items in the list. | +| `items_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique requisition list ID. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | #### Example @@ -1053,9 +1053,9 @@ Defines the contents of a requisition list. "description": "abc123", "items": RequistionListItems, "items_count": 987, - "name": "xyz789", - "uid": "4", - "updated_at": "xyz789" + "name": "abc123", + "uid": 4, + "updated_at": "abc123" } ``` @@ -1069,8 +1069,8 @@ Defines requisition list filters. | Input Field | Description | |-------------|-------------| -| `name` - [`FilterMatchTypeInput`](types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| `name` - [`FilterMatchTypeInput`](/reference/graphql/saas/types-f-i.md#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | #### Example @@ -1092,21 +1092,21 @@ The interface for requisition list items. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The amount added. | | `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for the requisition list item. | #### Possible Types | RequisitionListItemInterface Types | |----------------| -| [`BundleRequisitionListItem`](types-a-b.md#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](types-c-e.md#configurablerequisitionlistitem) | -| [`DownloadableRequisitionListItem`](types-c-e.md#downloadablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](types-f-i.md#giftcardrequisitionlistitem) | +| [`BundleRequisitionListItem`](/reference/graphql/saas/types-a-b.md#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](/reference/graphql/saas/types-c-e.md#configurablerequisitionlistitem) | +| [`DownloadableRequisitionListItem`](/reference/graphql/saas/types-c-e.md#downloadablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](/reference/graphql/saas/types-f-i.md#giftcardrequisitionlistitem) | | [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](types-t-z.md#virtualrequisitionlistitem) | +| [`VirtualRequisitionListItem`](/reference/graphql/saas/types-t-z.md#virtualrequisitionlistitem) | #### Example @@ -1116,7 +1116,7 @@ The interface for requisition list items. "product": ProductInterface, "quantity": 987.65, "sku": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -1130,9 +1130,9 @@ Defines the items to add. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | Entered option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/saas/types-c-e.md#enteredoptioninput) | Entered option IDs. | | `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](types-f-i.md#float) | The quantity of the product to add. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The quantity of the product to add. | | `selected_options` - [`[String]`](#string) | Selected option IDs. | | `sku` - [`String!`](#string) | The product SKU. | @@ -1197,7 +1197,7 @@ Defines customer requisition lists. | `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`](types-f-i.md#int) | The number of returned requisition lists. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The number of returned requisition lists. | #### Example @@ -1206,7 +1206,7 @@ Defines customer requisition lists. "items": [RequisitionList], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } ``` @@ -1222,7 +1222,7 @@ Contains an array of items added to a requisition list. |------------|-------------| | `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](types-f-i.md#int) | The number of pages returned. | +| `total_pages` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of pages returned. | #### Example @@ -1230,7 +1230,7 @@ Contains an array of items added to a requisition list. { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 987 + "total_pages": 123 } ``` @@ -1250,10 +1250,10 @@ Contains details about a return. | `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`](types-c-e.md#customerorder) | The order associated with the return. | +| `order` - [`CustomerOrder`](/reference/graphql/saas/types-c-e.md#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!`](types-f-i.md#id) | The unique ID for a `Return` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Return` object. | #### Example @@ -1264,7 +1264,7 @@ Contains details about a return. "created_at": "abc123", "customer": ReturnCustomer, "items": [ReturnItem], - "number": "xyz789", + "number": "abc123", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", @@ -1285,7 +1285,7 @@ Contains details about a return comment. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnComment` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ReturnComment` object. | #### Example @@ -1293,7 +1293,7 @@ Contains details about a return comment. { "author_name": "xyz789", "created_at": "abc123", - "text": "xyz789", + "text": "abc123", "uid": 4 } ``` @@ -1316,8 +1316,8 @@ The customer information for the return. ```json { - "email": "abc123", - "firstname": "abc123", + "email": "xyz789", + "firstname": "xyz789", "lastname": "xyz789" } ``` @@ -1332,12 +1332,12 @@ Contains details about a product being returned. | Field Name | Description | |------------|-------------| -| `custom_attributesV2` - [`[AttributeValueInterface]`](types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](types-f-i.md#float) | The quantity of the item requested to be returned. | +| `custom_attributesV2` - [`[AttributeValueInterface]`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of the item requested to be returned. | | `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnItem` object. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ReturnItem` object. | #### Example @@ -1345,8 +1345,8 @@ Contains details about a product being returned. { "custom_attributesV2": [AttributeValueInterface], "order_item": OrderItemInterface, - "quantity": 987.65, - "request_quantity": 123.45, + "quantity": 123.45, + "request_quantity": 987.65, "status": "PENDING", "uid": "4" } @@ -1362,34 +1362,34 @@ Return Item attribute metadata. | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](types-f-i.md#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `code` - [`ID!`](/reference/graphql/saas/types-f-i.md#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!`](types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `entity_type` - [`AttributeEntityTypeEnum!`](/reference/graphql/saas/types-a-b.md#attributeentitytypeenum) | The type of entity that defines the attribute. | | `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](types-a-b.md#boolean) | Whether the attribute value must be unique. | +| `frontend_input` - [`AttributeFrontendInputEnum`](/reference/graphql/saas/types-a-b.md#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](/reference/graphql/saas/types-f-i.md#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the attribute value must be unique. | | `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](types-f-i.md#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](types-c-e.md#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](types-f-i.md#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](types-t-z.md#validationrule) | The validation rules of the attribute value. | +| `multiline_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](/reference/graphql/saas/types-c-e.md#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](/reference/graphql/saas/types-t-z.md#validationrule) | The validation rules of the attribute value. | #### Example ```json { "code": 4, - "default_value": "abc123", + "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": 987, + "label": "xyz789", + "multiline_count": 123, "options": [CustomAttributeOptionInterface], "sort_order": 123, "validate_rules": [ValidationRule] @@ -1451,7 +1451,7 @@ Contains details about the shipping address used for receiving returned items. |------------|-------------| | `city` - [`String!`](#string) | The city for product returns. | | `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](types-c-e.md#country) | An object that defines the country for product returns. | +| `country` - [`Country!`](/reference/graphql/saas/types-c-e.md#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. | @@ -1462,7 +1462,7 @@ Contains details about the shipping address used for receiving returned items. ```json { "city": "xyz789", - "contact_name": "xyz789", + "contact_name": "abc123", "country": Country, "postcode": "xyz789", "region": Region, @@ -1482,7 +1482,7 @@ Contains details about the carrier on a return. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | #### Example @@ -1506,7 +1506,7 @@ Contains shipping and tracking details. | `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!`](types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | #### Example @@ -1535,7 +1535,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "abc123", "type": "INFORMATION"} +{"text": "xyz789", "type": "INFORMATION"} ``` @@ -1595,7 +1595,7 @@ Contains a list of customer return requests. |------------|-------------| | `items` - [`[Return]`](#return) | A list of return requests. | | `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](types-f-i.md#int) | The total number of return requests. | +| `total_count` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The total number of return requests. | #### Example @@ -1603,7 +1603,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1617,7 +1617,7 @@ Contains the result of a request to revoke a customer token. | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](types-a-b.md#boolean) | The result of a request to revoke a customer token. | +| `result` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | The result of a request to revoke a customer token. | #### Example @@ -1659,13 +1659,13 @@ Contains details about a customer's reward points. | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](types-k-p.md#money) | The reward points amount in store currency. | -| `points` - [`Float!`](types-f-i.md#float) | The reward points amount in points. | +| `money` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The reward points amount in store currency. | +| `points` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The reward points amount in points. | #### Example ```json -{"money": Money, "points": 123.45} +{"money": Money, "points": 987.65} ``` @@ -1681,15 +1681,15 @@ Contain details about the reward points transaction. | `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!`](types-f-i.md#float) | The number of points added or deducted in the transaction. | +| `points_change` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The number of points added or deducted in the transaction. | #### Example ```json { "balance": RewardPointsAmount, - "change_reason": "xyz789", - "date": "abc123", + "change_reason": "abc123", + "date": "xyz789", "points_change": 987.65 } ``` @@ -1726,8 +1726,8 @@ Contains details about customer's reward points rate. | Field Name | Description | |------------|-------------| -| `currency_amount` - [`Float!`](types-f-i.md#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!`](types-f-i.md#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. | +| `currency_amount` - [`Float!`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-f-i.md#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 @@ -1791,7 +1791,7 @@ Defines the name and value of a SDK parameter ```json { - "name": "xyz789", + "name": "abc123", "value": "abc123" } ``` @@ -1814,7 +1814,7 @@ Contains details about a comment. ```json { "message": "abc123", - "timestamp": "abc123" + "timestamp": "xyz789" } ``` @@ -1828,18 +1828,14 @@ For use on string and other scalar product fields | Field Name | Description | |------------|-------------| -| `count` - [`Int!`](types-f-i.md#int) | The number of items in the bucket | -| `id` - [`ID!`](types-f-i.md#id) | An identifier that can be used for filtering. It may contain non-human readable data | +| `count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of items in the bucket | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#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": 123, - "id": "4", - "title": "xyz789" -} +{"count": 123, "id": 4, "title": "abc123"} ``` @@ -1884,7 +1880,7 @@ A product attribute to filter on ```json { "attribute": "xyz789", - "contains": "xyz789", + "contains": "abc123", "eq": "xyz789", "in": ["xyz789"], "range": SearchRangeInput, @@ -1902,13 +1898,13 @@ A range of numeric values for use in a search | Input Field | Description | |-------------|-------------| -| `from` - [`Float`](types-f-i.md#float) | The minimum value to filter on. If not specified, the value of `0` is applied | -| `to` - [`Float`](types-f-i.md#float) | The maximum value to filter on | +| `from` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The minimum value to filter on. If not specified, the value of `0` is applied | +| `to` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The maximum value to filter on | #### Example ```json -{"from": 987.65, "to": 123.45} +{"from": 987.65, "to": 987.65} ``` @@ -1921,14 +1917,14 @@ Provides navigation for the query response. | Field Name | Description | |------------|-------------| -| `current_page` - [`Int`](types-f-i.md#int) | The specific page to return. | -| `page_size` - [`Int`](types-f-i.md#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](types-f-i.md#int) | The total number of pages in the response. | +| `current_page` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The specific page to return. | +| `page_size` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The total number of pages in the response. | #### Example ```json -{"current_page": 987, "page_size": 123, "total_pages": 123} +{"current_page": 123, "page_size": 987, "total_pages": 123} ``` @@ -1943,7 +1939,7 @@ Contains details about a selected bundle option. |------------|-------------| | `label` - [`String!`](#string) | The display name of the selected bundle product option. | | `type` - [`String!`](#string) | The type of selected bundle product option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `SelectedBundleOption` object | | `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example @@ -1951,8 +1947,8 @@ Contains details about a selected bundle option. ```json { "label": "xyz789", - "type": "abc123", - "uid": "4", + "type": "xyz789", + "uid": 4, "values": [SelectedBundleOptionValue] } ``` @@ -1968,19 +1964,19 @@ Contains details about a value for a selected bundle option. | Field Name | Description | |------------|-------------| | `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `original_price` - [`Money!`](types-k-p.md#money) | The original price of the value for the selected bundle product option. | -| `priceV2` - [`Money!`](types-k-p.md#money) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `original_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The original price of the value for the selected bundle product option. | +| `priceV2` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `SelectedBundleOptionValue` object | #### Example ```json { - "label": "xyz789", + "label": "abc123", "original_price": Money, "priceV2": Money, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` @@ -1995,8 +1991,8 @@ Contains details about a selected configurable option. | Field Name | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `configurable_product_option_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#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. | @@ -2004,9 +2000,9 @@ Contains details about a selected configurable option. ```json { - "configurable_product_option_uid": "4", + "configurable_product_option_uid": 4, "configurable_product_option_value_uid": 4, - "option_label": "abc123", + "option_label": "xyz789", "value_label": "xyz789" } ``` @@ -2028,8 +2024,8 @@ Contains details about an attribute the buyer selected. ```json { - "attribute_code": "abc123", - "value": "abc123" + "attribute_code": "xyz789", + "value": "xyz789" } ``` @@ -2043,10 +2039,10 @@ Identifies a customized product that has been placed in a cart. | Field Name | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `is_required` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the customizable option is required. | +| `customizable_option_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `is_required` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customizable option is required. | | `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](types-f-i.md#int) | A value indicating the order to display this option. | +| `sort_order` - [`Int!`](/reference/graphql/saas/types-f-i.md#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. | @@ -2054,10 +2050,10 @@ Identifies a customized product that has been placed in a cart. ```json { - "customizable_option_uid": "4", - "is_required": true, - "label": "abc123", - "sort_order": 987, + "customizable_option_uid": 4, + "is_required": false, + "label": "xyz789", + "sort_order": 123, "type": "xyz789", "values": [SelectedCustomizableOptionValue] } @@ -2073,17 +2069,17 @@ Identifies the value of the selected customized option. | Field Name | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](types-f-i.md#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `customizable_option_value_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#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!`](types-c-e.md#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](/reference/graphql/saas/types-c-e.md#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", + "customizable_option_value_uid": 4, + "label": "xyz789", "price": CartItemSelectedOptionValuePrice, "value": "xyz789" } @@ -2100,7 +2096,7 @@ Describes the payment method selected by the shopper. | Field Name | Description | |------------|-------------| | `code` - [`String!`](#string) | The payment method code. | -| `oope_payment_method_config` - [`OopePaymentMethodConfig`](types-k-p.md#oopepaymentmethodconfig) | Configuration for out of process payment methods | +| `oope_payment_method_config` - [`OopePaymentMethodConfig`](/reference/graphql/saas/types-k-p.md#oopepaymentmethodconfig) | Configuration for out of process payment methods | | `purchase_order_number` - [`String`](#string) | The purchase order number. | | `title` - [`String!`](#string) | The payment method title. | @@ -2110,8 +2106,8 @@ Describes the payment method selected by the shopper. { "code": "xyz789", "oope_payment_method_config": OopePaymentMethodConfig, - "purchase_order_number": "abc123", - "title": "xyz789" + "purchase_order_number": "xyz789", + "title": "abc123" } ``` @@ -2126,13 +2122,13 @@ Contains details about the selected shipping method and carrier. | Field Name | Description | |------------|-------------| | `additional_data` - [`[ShippingAdditionalData]`](#shippingadditionaldata) | Additional data related to the shipping method. | -| `amount` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method. | +| `amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#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!`](types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | +| `price_excl_tax` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The cost of shipping using this shipping method, including tax. | #### Example @@ -2141,8 +2137,8 @@ Contains details about the selected shipping method and carrier. "additional_data": [ShippingAdditionalData], "amount": Money, "carrier_code": "abc123", - "carrier_title": "abc123", - "method_code": "abc123", + "carrier_title": "xyz789", + "method_code": "xyz789", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -2159,8 +2155,8 @@ Specifies which negotiable quote to send for review. | Input Field | Description | |-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `comment` - [`NegotiableQuoteCommentInput`](/reference/graphql/saas/types-k-p.md#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2178,7 +2174,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2196,7 +2192,7 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](types-a-b.md#billingaddressinput) | The billing address. | +| `billing_address` - [`BillingAddressInput!`](/reference/graphql/saas/types-a-b.md#billingaddressinput) | The billing address. | | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example @@ -2204,7 +2200,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "abc123" + "cart_id": "xyz789" } ``` @@ -2218,7 +2214,7 @@ Contains details about the cart after setting the billing address. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the billing address. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after setting the billing address. | #### Example @@ -2237,12 +2233,12 @@ Sets the cart as inactive | Field Name | Description | |------------|-------------| | `error` - [`String`](#string) | The error message returned after failing to set the cart as inactive | -| `success` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the cart was set as inactive | +| `success` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the cart was set as inactive | #### Example ```json -{"error": "abc123", "success": true} +{"error": "xyz789", "success": true} ``` @@ -2255,8 +2251,8 @@ Defines the company custom attributes. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for company. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID of a `company` object. | +| `custom_attributes` - [`[CustomAttributeInput]`](/reference/graphql/saas/types-c-e.md#customattributeinput) | An array of custom attributes for company. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `company` object. | #### Example @@ -2274,7 +2270,7 @@ Contains the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company`](types-c-e.md#company) | The company after assigning custom attributes. | +| `company` - [`Company`](/reference/graphql/saas/types-c-e.md#company) | The company after assigning custom attributes. | #### Example @@ -2292,8 +2288,8 @@ Defines the negotiable quote custom attributes. | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](types-c-e.md#customattributeinput) | An array of custom attributes for NegotiableQuote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `custom_attributes` - [`[CustomAttributeInput]`](/reference/graphql/saas/types-c-e.md#customattributeinput) | An array of custom attributes for NegotiableQuote. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2314,7 +2310,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning custom attributes. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after assigning custom attributes. | #### Example @@ -2333,20 +2329,20 @@ Defines the gift options applied to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](types-f-i.md#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](types-a-b.md#boolean) | Whether customer requested printed card for the cart. | +| `gift_message` - [`GiftMessageInput`](/reference/graphql/saas/types-f-i.md#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether customer requested printed card for the cart. | #### Example ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_message": GiftMessageInput, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping_id": "4", - "printed_card_included": true + "printed_card_included": false } ``` @@ -2360,7 +2356,7 @@ Contains the cart after gift options have been applied. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The modified cart object. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The modified cart object. | #### Example @@ -2386,7 +2382,7 @@ Defines the guest email and cart. ```json { "cart_id": "abc123", - "email": "xyz789" + "email": "abc123" } ``` @@ -2400,7 +2396,7 @@ Contains details about the cart after setting the email of a guest. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the guest email. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after setting the guest email. | #### Example @@ -2418,7 +2414,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after sending for seller review. | #### Example @@ -2436,15 +2432,15 @@ Sets the billing address. | Input Field | Description | |-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](/reference/graphql/saas/types-k-p.md#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -2458,7 +2454,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example @@ -2476,8 +2472,8 @@ Defines the payment method of the specified negotiable quote. | Input Field | Description | |-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](/reference/graphql/saas/types-k-p.md#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -2498,7 +2494,7 @@ Contains details about the negotiable quote after setting the payment method. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -2516,14 +2512,14 @@ Defines the shipping address to assign to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](/reference/graphql/saas/types-k-p.md#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "quote_uid": "4", + "quote_uid": 4, "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2540,7 +2536,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example @@ -2558,14 +2554,14 @@ Defines the shipping method to apply to the negotiable quote. | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#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", + "quote_uid": 4, "shipping_methods": [ShippingMethodInput] } ``` @@ -2580,7 +2576,7 @@ Contains the negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example @@ -2598,15 +2594,15 @@ Defines the shipping address to assign to the negotiable quote template. | Input Field | Description | |-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": "4" + "template_id": 4 } ``` @@ -2621,13 +2617,13 @@ Applies a payment method to the cart. | Input Field | Description | |-------------|-------------| | `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | +| `payment_method` - [`PaymentMethodInput!`](/reference/graphql/saas/types-k-p.md#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "payment_method": PaymentMethodInput } ``` @@ -2642,7 +2638,7 @@ Contains details about the cart after setting the payment method. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the payment method. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after setting the payment method. | #### Example @@ -2667,7 +2663,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2682,7 +2678,7 @@ Contains details about the cart after setting the shipping addresses. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping addresses. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after setting the shipping addresses. | #### Example @@ -2722,7 +2718,7 @@ Contains details about the cart after setting the shipping methods. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after setting the shipping methods. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after setting the shipping methods. | #### Example @@ -2747,7 +2743,7 @@ Defines a gift registry invitee. ```json { - "email": "abc123", + "email": "xyz789", "name": "xyz789" } ``` @@ -2762,7 +2758,7 @@ Contains the results of a request to share a gift registry. | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | +| `is_shared` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the gift registry was successfully shared. | #### Example @@ -2788,7 +2784,7 @@ Defines the sender of an invitation to view a gift registry. ```json { "message": "abc123", - "name": "abc123" + "name": "xyz789" } ``` @@ -2802,8 +2798,8 @@ An input object that defines which requisition list shared with company users th | Input Field | Description | |-------------|-------------| -| `customerUids` - [`[ID]!`](types-f-i.md#id) | An array of IDs representing company users with whom the sender wants to share the requisition list. | -| `requisitionListUid` - [`ID!`](types-f-i.md#id) | The unique ID of the requisition list. | +| `customerUids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of IDs representing company users with whom the sender wants to share the requisition list. | +| `requisitionListUid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the requisition list. | #### Example @@ -2824,14 +2820,14 @@ Result of sharing a requisition list by email. | Field Name | Description | |------------|-------------| -| `sent_count` - [`Int!`](types-f-i.md#int) | Number of notification emails successfully sent. | +| `sent_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Number of notification emails successfully sent. | | `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Per-email validation or delivery issues. | #### Example ```json { - "sent_count": 123, + "sent_count": 987, "user_errors": [ShareRequisitionListUserError] } ``` @@ -2851,7 +2847,7 @@ The result of sharing a requisition list by token. #### Example ```json -{"token": "xyz789"} +{"token": "abc123"} ``` @@ -2872,7 +2868,7 @@ An error related to a specific recipient or constraint. ```json { "code": "MAX_RECIPIENTS_EXCEEDED", - "message": "xyz789" + "message": "abc123" } ``` @@ -2946,12 +2942,12 @@ Defines whether bundle items must be shipped together. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | #### Example @@ -2959,9 +2955,9 @@ Defines whether bundle items must be shipped together. { "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_shipped": 987.65 } ``` @@ -2976,30 +2972,30 @@ Order shipment item details. | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](/reference/graphql/saas/types-k-p.md#orderiteminterface) | The order item associated with the shipment item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](types-k-p.md#money) | The sale price for the base product. | +| `product_sale_price` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The sale price for the base product. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](types-f-i.md#float) | The number of shipped items. | +| `quantity_shipped` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The number of shipped items. | #### Possible Types | ShipmentItemInterface Types | |----------------| -| [`BundleShipmentItem`](types-a-b.md#bundleshipmentitem) | -| [`GiftCardShipmentItem`](types-f-i.md#giftcardshipmentitem) | +| [`BundleShipmentItem`](/reference/graphql/saas/types-a-b.md#bundleshipmentitem) | +| [`GiftCardShipmentItem`](/reference/graphql/saas/types-f-i.md#giftcardshipmentitem) | | [`ShipmentItem`](#shipmentitem) | #### Example ```json { - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_shipped": 123.45 } ``` @@ -3023,8 +3019,8 @@ Contains order shipment tracking details. ```json { - "carrier": "abc123", - "number": "xyz789", + "carrier": "xyz789", + "number": "abc123", "title": "abc123", "tracking_url": "abc123" } @@ -3047,7 +3043,7 @@ A simple key value object. ```json { - "key": "abc123", + "key": "xyz789", "value": "xyz789" } ``` @@ -3062,9 +3058,9 @@ Defines a single shipping address. | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](types-c-e.md#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `address` - [`CartAddressInput`](/reference/graphql/saas/types-c-e.md#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#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. | @@ -3074,7 +3070,7 @@ Defines a single shipping address. { "address": CartAddressInput, "customer_address_id": 987, - "customer_address_uid": 4, + "customer_address_uid": "4", "customer_notes": "xyz789", "pickup_location_code": "abc123" } @@ -3090,29 +3086,29 @@ Contains shipping addresses and methods. | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items_v2` - [`[CartItemInterface]`](types-c-e.md#cartiteminterface) | An array that lists the items in the cart. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](/reference/graphql/saas/types-a-b.md#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items_v2` - [`[CartItemInterface]`](/reference/graphql/saas/types-c-e.md#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!`](types-c-e.md#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](types-f-i.md#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `country` - [`CartAddressCountry!`](/reference/graphql/saas/types-c-e.md#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#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`](types-f-i.md#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `id` - [`Int`](/reference/graphql/saas/types-f-i.md#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`](types-c-e.md#cartaddressregion) | An object containing the region label and code. | -| `same_as_billing` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether the shipping address is same as billing address. | +| `region` - [`CartAddressRegion`](/reference/graphql/saas/types-c-e.md#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](types-f-i.md#id) | The unique id of the customer cart address. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique id of the customer cart address. | | `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example @@ -3121,28 +3117,28 @@ Contains shipping addresses and methods. { "available_shipping_methods": [AvailableShippingMethod], "cart_items_v2": [CartItemInterface], - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", - "customer_notes": "xyz789", - "fax": "abc123", + "customer_address_uid": 4, + "customer_notes": "abc123", + "fax": "xyz789", "firstname": "abc123", "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", - "pickup_location_code": "abc123", + "lastname": "abc123", + "middlename": "abc123", + "pickup_location_code": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", - "uid": "4", - "vat_id": "xyz789" + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "uid": 4, + "vat_id": "abc123" } ``` @@ -3156,7 +3152,7 @@ Defines an individual shipping discount. This discount can be applied to shippin | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of the discount. | +| `amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The amount of the discount. | #### Example @@ -3174,11 +3170,11 @@ Contains details about shipping and handling costs. | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](types-k-p.md#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](types-k-p.md#money) | The shipping amount, including tax. | +| `amount_excluding_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The shipping amount, including tax. | | `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](types-t-z.md#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](types-k-p.md#money) | The total amount for shipping. | +| `taxes` - [`[TaxItem]`](/reference/graphql/saas/types-t-z.md#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The total amount for shipping. | #### Example @@ -3210,7 +3206,7 @@ Defines the shipping carrier and method. ```json { "carrier_code": "xyz789", - "method_code": "xyz789" + "method_code": "abc123" } ``` @@ -3224,25 +3220,25 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](types-f-i.md#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](/reference/graphql/saas/types-f-i.md#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]`](types-c-e.md#customattribute) | The custom attributes for the cart item | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the cart item | | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](types-f-i.md#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | +| `discount` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/saas/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](/reference/graphql/saas/types-f-i.md#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](/reference/graphql/saas/types-f-i.md#giftwrapping) | The selected gift wrapping for the cart item. | +| `is_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#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]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/saas/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example @@ -3256,11 +3252,11 @@ An implementation for simple product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, - "is_salable": false, + "is_available": true, + "is_salable": true, "max_qty": 123.45, - "min_qty": 123.45, - "not_available_message": "abc123", + "min_qty": 987.65, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -3281,79 +3277,79 @@ Defines a simple product, which is tangible and is usually sold in single units | 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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `categories` - [`[CategoryInterface]`](/reference/graphql/saas/types-c-e.md#categoryinterface) | The categories assigned to a product. | | `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/saas/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#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`](types-f-i.md#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `manufacturer` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#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`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `min_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#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`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/saas/types-c-e.md#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!`](types-k-p.md#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](types-t-z.md#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](/reference/graphql/saas/types-t-z.md#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#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`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | +| `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](/reference/graphql/saas/types-f-i.md#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`](types-k-p.md#productstockstatus) | Stock status of the product | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/saas/types-k-p.md#productstockstatus) | Stock status of the product | | `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | +| `thumbnail` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Upsell Products | | `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `weight` - [`Float`](types-f-i.md#float) | The weight of the item, in units defined by the store. | +| `weight` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, + "gift_message_available": true, "gift_wrapping_available": true, "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": "xyz789", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", - "min_sale_qty": 123.45, + "min_sale_qty": 987.65, "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, "sku": "abc123", @@ -3365,8 +3361,8 @@ Defines a simple product, which is tangible and is usually sold in single units "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123", - "weight": 987.65 + "url_key": "xyz789", + "weight": 123.45 } ``` @@ -3380,27 +3376,27 @@ Represents a single-SKU product without selectable variants. Because there are n | Field Name | Description | |------------|-------------| -| `addToCartAllowed` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | -| `inStock` - [`Boolean`](types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | -| `lowStock` - [`Boolean`](types-a-b.md#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]`](types-k-p.md#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by names and roles. | +| `addToCartAllowed` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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]`](/reference/graphql/saas/types-k-p.md#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!`](types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | -| `images` - [`[ProductViewImage]`](types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image`, and `swatch`. | -| `videos` - [`[ProductViewVideo]`](types-k-p.md#productviewvideo) | A list of videos defined for the product. | -| `inputOptions` - [`[ProductViewInputOption]`](types-k-p.md#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`](types-c-e.md#datetime) | Date and time when the product was last updated. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | +| `images` - [`[ProductViewImage]`](/reference/graphql/saas/types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image`, and `swatch`. | +| `videos` - [`[ProductViewVideo]`](/reference/graphql/saas/types-k-p.md#productviewvideo) | A list of videos defined for the product. | +| `inputOptions` - [`[ProductViewInputOption]`](/reference/graphql/saas/types-k-p.md#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`](/reference/graphql/saas/types-c-e.md#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`](types-k-p.md#productviewprice) | Base product price view. | +| `price` - [`ProductViewPrice`](/reference/graphql/saas/types-k-p.md#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]`](types-k-p.md#productviewlink) | A list of product links. For example, a related product, an up-sell product or a cross-sell product. | +| `links` - [`[ProductViewLink]`](/reference/graphql/saas/types-k-p.md#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 | @@ -3408,9 +3404,9 @@ Represents a single-SKU product without selectable variants. Because there are n ```json { - "addToCartAllowed": false, + "addToCartAllowed": true, "inStock": true, - "lowStock": false, + "lowStock": true, "attributes": [ProductViewAttribute], "description": "xyz789", "id": 4, @@ -3418,15 +3414,15 @@ Represents a single-SKU product without selectable variants. Because there are n "videos": [ProductViewVideo], "inputOptions": [ProductViewInputOption], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", - "metaKeyword": "abc123", + "metaDescription": "xyz789", + "metaKeyword": "xyz789", "metaTitle": "xyz789", - "name": "xyz789", + "name": "abc123", "price": ProductViewPrice, "shortDescription": "abc123", - "sku": "xyz789", - "externalId": "xyz789", - "url": "abc123", + "sku": "abc123", + "externalId": "abc123", + "url": "xyz789", "urlKey": "abc123", "links": [ProductViewLink], "queryType": "xyz789", @@ -3445,10 +3441,10 @@ Contains details about simple products added to a requisition list. | Field Name | Description | |------------|-------------| | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The amount added. | | `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -3458,7 +3454,7 @@ Contains details about simple products added to a requisition list. "product": ProductInterface, "quantity": 123.45, "sku": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -3475,9 +3471,9 @@ Contains a simple 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!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -3485,10 +3481,10 @@ Contains a simple product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -3510,9 +3506,9 @@ Smart button payment inputs ```json { - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" } ``` @@ -3524,13 +3520,13 @@ Smart button payment inputs | Field Name | Description | |------------|-------------| -| `app_switch_when_available` - [`Boolean`](types-a-b.md#boolean) | Indicated whether to use App Switch on enabled mobile devices | -| `button_styles` - [`ButtonStyles`](types-a-b.md#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `app_switch_when_available` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicated whether to use App Switch on enabled mobile devices | +| `button_styles` - [`ButtonStyles`](/reference/graphql/saas/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](types-a-b.md#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](types-k-p.md#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `display_message` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](/reference/graphql/saas/types-k-p.md#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 | @@ -3540,16 +3536,16 @@ Smart button payment inputs ```json { - "app_switch_when_available": false, + "app_switch_when_available": true, "button_styles": ButtonStyles, - "code": "abc123", + "code": "xyz789", "display_message": false, "display_venmo": false, "is_visible": true, "message_styles": MessageStyles, - "payment_intent": "abc123", + "payment_intent": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "title": "xyz789" } ``` @@ -3612,7 +3608,7 @@ Contains a default value for sort fields and all available sort fields. ```json { - "default": "xyz789", + "default": "abc123", "options": [SortField] } ``` @@ -3680,15 +3676,15 @@ Contains product attributes that be used for sorting in a `productSearch` query | `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`](types-a-b.md#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | +| `numeric` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | #### Example ```json { - "attribute": "abc123", + "attribute": "xyz789", "frontendInput": "xyz789", - "label": "abc123", + "label": "xyz789", "numeric": true } ``` @@ -3703,8 +3699,8 @@ For retrieving statistics across multiple buckets | Field Name | Description | |------------|-------------| -| `max` - [`Float!`](types-f-i.md#float) | The maximum value | -| `min` - [`Float!`](types-f-i.md#float) | The minimum value | +| `max` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The maximum value | +| `min` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The minimum value | | `title` - [`String!`](#string) | The display text for the bucket | #### Example @@ -3712,8 +3708,8 @@ For retrieving statistics across multiple buckets ```json { "max": 123.45, - "min": 123.45, - "title": "xyz789" + "min": 987.65, + "title": "abc123" } ``` @@ -3727,71 +3723,71 @@ Contains information about a store's configuration. | Field Name | Description | |------------|-------------| -| `allow_company_registration` - [`Boolean!`](types-a-b.md#boolean) | Indicates if company registration is allowed | +| `allow_company_registration` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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`](types-a-b.md#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `autocomplete_on_storefront` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#int) | checkout/cart/delete_quote_after: quote lifetime in days. | +| `cart_expires_in_days` - [`Int`](/reference/graphql/saas/types-f-i.md#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`](types-f-i.md#int) | checkout/cart_link/use_qty: what to show in the display cart summary, number of items or item quantities. | +| `cart_summary_display_quantity` - [`Int`](/reference/graphql/saas/types-f-i.md#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`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/saas/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#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_sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates if company credit is enabled. | -| `company_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates if B2B company functionality is enabled | -| `configurable_product_image` - [`ProductImageThumbnail!`](types-k-p.md#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | +| `company_credit_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates if company credit is enabled. | +| `company_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates if B2B company functionality is enabled | +| `configurable_product_image` - [`ProductImageThumbnail!`](/reference/graphql/saas/types-k-p.md#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!`](types-a-b.md#boolean) | Indicates whether the Contact Us form in enabled. | +| `contact_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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`](types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](types-f-i.md#float) | Customer access token lifetime. | +| `create_account_confirmation` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](/reference/graphql/saas/types-f-i.md#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!`](types-f-i.md#int) | Configuration data from tax/display/type | -| `display_shipping_prices` - [`Int!`](types-f-i.md#int) | Configuration data from tax/display/shipping | -| `display_state_if_optional` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - general/region/display_all | +| `display_product_prices_in_catalog` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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!`](types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | -| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_email | -| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_list | -| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display_sales | -| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](types-f-i.md#int) | Configuration data from tax/weee/display | -| `fixed_product_taxes_enable` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/enable | -| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/weee/include_in_subtotal | -| `graphql_share_customer_group` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | -| `grid_per_page` - [`Int`](types-f-i.md#int) | The default number of products per page in Grid View. | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from tax/weee/include_in_subtotal | +| `graphql_share_customer_group` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](/reference/graphql/saas/types-f-i.md#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!`](types-k-p.md#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | -| `is_checkout_agreements_enabled` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | -| `is_default_store` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | -| `is_negotiable_quote_active` - [`Boolean`](types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](types-a-b.md#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | +| `grouped_product_image` - [`ProductImageThumbnail!`](/reference/graphql/saas/types-k-p.md#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | +| `is_checkout_agreements_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#int) | The default number of products per page in List View. | +| `list_per_page` - [`Int`](/reference/graphql/saas/types-f-i.md#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). | @@ -3808,156 +3804,156 @@ Contains information about a store's configuration. | `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`](types-f-i.md#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | +| `max_items_in_order_summary` - [`Int`](/reference/graphql/saas/types-f-i.md#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`](types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | -| `minicart_max_items` - [`Int`](types-f-i.md#int) | checkout/sidebar/count: maximum number of items to show in minicart. | +| `minicart_display` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](/reference/graphql/saas/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether newsletters are enabled. | +| `newsletter_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether newsletters are enabled. | | `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | -| `order_cancellation_enabled` - [`Boolean!`](types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | -| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | -| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | -| `orders_invoices_credit_memos_display_price` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/price | -| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/shipping | -| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | -| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from tax/sales_display/zero_tax | -| `printed_card_priceV2` - [`Money`](types-k-p.md#money) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages. | +| `order_cancellation_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](/reference/graphql/saas/types-c-e.md#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from tax/sales_display/zero_tax | +| `printed_card_priceV2` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/saas/types-f-i.md#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!`](types-a-b.md#boolean) | Indicates whether quick order functionality is enabled. | -| `quote_minimum_amount` - [`Float`](types-f-i.md#float) | Minimum order total for quote request. | +| `quickorder_active` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether quick order functionality is enabled. | +| `quote_minimum_amount` - [`Float`](/reference/graphql/saas/types-f-i.md#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!`](types-f-i.md#int) | Configuration data from btob/requisition_list_sharing/link_validity_days | -| `requisition_list_share_max_recipients` - [`Int!`](types-f-i.md#int) | Configuration data from btob/requisition_list_sharing/max_recipients | +| `requisition_list_share_link_validity_days` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from btob/requisition_list_sharing/link_validity_days | +| `requisition_list_share_max_recipients` - [`Int!`](/reference/graphql/saas/types-f-i.md#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!`](types-a-b.md#boolean) | Configuration data from btob/requisition_list_sharing/enabled | +| `requisition_list_sharing_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](types-f-i.md#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. | +| `root_category_uid` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](/reference/graphql/saas/types-f-i.md#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!`](types-a-b.md#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | -| `share_applied_cart_rule` - [`Boolean!`](types-a-b.md#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | +| `share_active_segments` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | +| `share_applied_cart_rule` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](types-a-b.md#boolean) | Configuration data from login_as_customer/general/enabled | -| `shopping_cart_display_full_summary` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `store_code` - [`ID`](types-f-i.md#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`](types-f-i.md#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `shopping_assistance_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from login_as_customer/general/enabled | +| `shopping_cart_display_full_summary` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](/reference/graphql/saas/types-t-z.md#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `store_code` - [`ID`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-f-i.md#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`](types-f-i.md#int) | The store view sort order. | +| `store_sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](types-f-i.md#id) | The unique ID for the website. | +| `use_store_in_url` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](/reference/graphql/saas/types-f-i.md#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`](types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](types-a-b.md#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_enable_for_specific_countries` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#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`](types-f-i.md#int) | A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout. | +| `zero_subtotal_sort_order` - [`Int`](/reference/graphql/saas/types-f-i.md#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": false, + "allow_company_registration": true, "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "abc123", - "allow_items": "abc123", + "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order_items": "xyz789", + "allow_items": "xyz789", "allow_order": "xyz789", "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_media_url": "xyz789", + "base_static_url": "abc123", "base_url": "xyz789", "cart_expires_in_days": 987, "cart_gift_wrapping": "abc123", "cart_merge_preference": "abc123", - "cart_printed_card": "abc123", - "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "abc123", + "cart_printed_card": "xyz789", + "cart_summary_display_quantity": 123, + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "abc123", - "check_money_order_enable_for_specific_countries": true, + "category_url_suffix": "xyz789", + "check_money_order_enable_for_specific_countries": false, "check_money_order_enabled": true, - "check_money_order_make_check_payable_to": "abc123", - "check_money_order_max_order_total": "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": "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", + "check_money_order_title": "abc123", "company_credit_enabled": false, - "company_enabled": true, + "company_enabled": false, "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", + "configurable_thumbnail_source": "xyz789", "contact_enabled": true, "countries_with_required_region": "xyz789", "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, + "customer_access_token_lifetime": 987.65, "default_country": "abc123", "default_display_currency_code": "xyz789", "display_product_prices_in_catalog": 987, - "display_shipping_prices": 123, + "display_shipping_prices": 987, "display_state_if_optional": true, "enable_multiple_wishlists": "abc123", "fixed_product_taxes_apply_tax_to_fpt": false, - "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 123, - "fixed_product_taxes_display_prices_in_sales_modules": 987, + "fixed_product_taxes_display_prices_in_emails": 123, + "fixed_product_taxes_display_prices_in_product_lists": 987, + "fixed_product_taxes_display_prices_in_sales_modules": 123, "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": false, - "fixed_product_taxes_include_fpt_in_subtotal": true, - "graphql_share_customer_group": false, - "grid_per_page": 987, + "fixed_product_taxes_enable": true, + "fixed_product_taxes_include_fpt_in_subtotal": false, + "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": true, - "is_default_store_group": false, + "is_checkout_agreements_enabled": 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_one_page_checkout_enabled": true, "is_requisition_list_active": "xyz789", "list_mode": "xyz789", - "list_per_page": 987, - "list_per_page_values": "xyz789", - "locale": "xyz789", + "list_per_page": 123, + "list_per_page_values": "abc123", + "locale": "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": "abc123", "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "abc123", - "magento_reward_points_invitation_order": "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": "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": "abc123", + "magento_reward_points_register": "xyz789", + "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", @@ -3965,64 +3961,64 @@ Contains information about a store's configuration. "minicart_max_items": 987, "minimum_password_length": "xyz789", "newsletter_enabled": true, - "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "optional_zip_countries": "xyz789", + "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": 123, - "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_subtotal": 987, "orders_invoices_credit_memos_display_zero_tax": true, "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_url_suffix": "abc123", - "quickorder_active": true, - "quote_minimum_amount": 987.65, - "quote_minimum_amount_message": "xyz789", - "required_character_classes_number": "xyz789", + "quickorder_active": false, + "quote_minimum_amount": 123.45, + "quote_minimum_amount_message": "abc123", + "required_character_classes_number": "abc123", "requisition_list_share_link_validity_days": 987, "requisition_list_share_max_recipients": 123, - "requisition_list_share_storefront_path": "xyz789", - "requisition_list_sharing_enabled": false, + "requisition_list_share_storefront_path": "abc123", + "requisition_list_sharing_enabled": true, "returns_enabled": "xyz789", - "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": "xyz789", - "secure_base_link_url": "xyz789", + "sales_printed_card": "abc123", + "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_static_url": "abc123", + "secure_base_url": "abc123", "share_active_segments": false, "share_applied_cart_rule": true, "shopping_assistance_checkbox_title": "xyz789", "shopping_assistance_checkbox_tooltip": "abc123", "shopping_assistance_enabled": false, - "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": true, + "shopping_cart_display_full_summary": false, + "shopping_cart_display_grand_total": false, "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 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": true, - "store_code": "4", - "store_group_code": "4", + "shopping_cart_display_zero_tax": false, + "store_code": 4, + "store_group_code": 4, "store_group_name": "abc123", "store_name": "xyz789", "store_sort_order": 987, "timezone": "xyz789", - "title_separator": "abc123", - "use_store_in_url": true, + "title_separator": "xyz789", + "use_store_in_url": false, "website_code": 4, - "website_name": "xyz789", - "weight_unit": "abc123", + "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_enabled": true, + "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_sort_order": 987, "zero_subtotal_title": "abc123" } ``` @@ -4083,27 +4079,27 @@ Specifies the quote template properties to update. | Input Field | Description | |-------------|-------------| -| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](types-k-p.md#negotiablequotecommentattachmentinput) | Negotiable quote template comment file attachments. | +| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](/reference/graphql/saas/types-k-p.md#negotiablequotecommentattachmentinput) | Negotiable quote template comment file attachments. | | `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](types-f-i.md#int) | Commitment for minimum orders | +| `max_order_commitment` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Commitment for minimum orders | | `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "xyz789", + "comment": "abc123", "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], - "template_id": 4 + "template_id": "4" } ``` @@ -4156,13 +4152,13 @@ Represents the subtree of the categories to retrieve. | Input Field | Description | |-------------|-------------| -| `depth` - [`Int!`](types-f-i.md#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!`](types-f-i.md#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. | +| `depth` - [`Int!`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-f-i.md#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": 987, "startLevel": 123} +{"depth": 987, "startLevel": 987} ``` @@ -4179,14 +4175,14 @@ Represents the subtree of the categories to retrieve. | SwatchDataInterface Types | |----------------| -| [`ColorSwatchData`](types-c-e.md#colorswatchdata) | -| [`ImageSwatchData`](types-f-i.md#imageswatchdata) | -| [`TextSwatchData`](types-t-z.md#textswatchdata) | +| [`ColorSwatchData`](/reference/graphql/saas/types-c-e.md#colorswatchdata) | +| [`ImageSwatchData`](/reference/graphql/saas/types-f-i.md#imageswatchdata) | +| [`TextSwatchData`](/reference/graphql/saas/types-t-z.md#textswatchdata) | #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -4262,8 +4258,8 @@ Synchronizes the payment order details ```json { - "cartId": "xyz789", - "id": "xyz789" + "cartId": "abc123", + "id": "abc123" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md index 379174e72..bb9430755 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md @@ -8,9 +8,9 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](types-k-p.md#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](types-f-i.md#float) | The rate used to calculate the tax. | -| `title` - [`String!`](types-q-s.md#string) | A title that describes the tax. | +| `amount` - [`Money!`](/reference/graphql/saas/types-k-p.md#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The rate used to calculate the tax. | +| `title` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A title that describes the tax. | #### Example @@ -18,7 +18,7 @@ Contains tax item details. { "amount": Money, "rate": 987.65, - "title": "abc123" + "title": "xyz789" } ``` @@ -48,7 +48,7 @@ Contains tax item details. | Field Name | Description | |------------|-------------| -| `value` - [`String`](types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The value can be represented as color (HEX code), image link, or text. | #### Example @@ -86,9 +86,9 @@ Defines a price based on the quantity purchased. | Field Name | Description | |------------|-------------| -| `discount` - [`ProductDiscount`](types-k-p.md#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](types-k-p.md#money) | The price of the product at this tier. | -| `quantity` - [`Float`](types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | +| `discount` - [`ProductDiscount`](/reference/graphql/saas/types-k-p.md#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | The price of the product at this tier. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The minimum number of items that must be purchased to qualify for this price tier. | #### Example @@ -96,7 +96,7 @@ Defines a price based on the quantity purchased. { "discount": ProductDiscount, "final_price": Money, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -110,7 +110,7 @@ Defines the input schema for unassigning a child company from its parent company | Input Field | Description | |-------------|-------------| -| `child_company_id` - [`ID!`](types-f-i.md#id) | The unique ID of the child company. | +| `child_company_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the child company. | #### Example @@ -128,7 +128,7 @@ Contains the response to the request to unassign a child company. | Field Name | Description | |------------|-------------| -| `company_hierarchy` - [`CompanyHierarchy!`](types-c-e.md#companyhierarchy) | The updated company relation hierarchy for the current company. | +| `company_hierarchy` - [`CompanyHierarchy!`](/reference/graphql/saas/types-c-e.md#companyhierarchy) | The updated company relation hierarchy for the current company. | #### Example @@ -144,25 +144,25 @@ Contains the response to the request to unassign a child company. | Input Field | Description | |-------------|-------------| -| `unitName` - [`String`](types-q-s.md#string) | | -| `storefrontLabel` - [`String`](types-q-s.md#string) | | -| `pagePlacement` - [`String`](types-q-s.md#string) | | -| `displayNumber` - [`Int`](types-f-i.md#int) | | -| `pageType` - [`String`](types-q-s.md#string) | | -| `unitStatus` - [`String`](types-q-s.md#string) | | -| `typeId` - [`String`](types-q-s.md#string) | | -| `filterRules` - [`[FilterRuleInput]`](types-f-i.md#filterruleinput) | | +| `unitName` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `storefrontLabel` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `pagePlacement` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `displayNumber` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | | +| `pageType` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `unitStatus` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `typeId` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | +| `filterRules` - [`[FilterRuleInput]`](/reference/graphql/saas/types-f-i.md#filterruleinput) | | #### Example ```json { - "unitName": "xyz789", + "unitName": "abc123", "storefrontLabel": "xyz789", "pagePlacement": "xyz789", "displayNumber": 123, "pageType": "abc123", - "unitStatus": "abc123", + "unitStatus": "xyz789", "typeId": "xyz789", "filterRules": [FilterRuleInput] } @@ -178,14 +178,14 @@ Modifies the specified items in the cart. | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](types-q-s.md#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](types-c-e.md#cartitemupdateinput) | An array of items to be updated. | +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](/reference/graphql/saas/types-c-e.md#cartitemupdateinput) | An array of items to be updated. | #### Example ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [CartItemUpdateInput] } ``` @@ -200,8 +200,8 @@ Contains details about the cart after updating items. | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](types-c-e.md#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](/reference/graphql/saas/types-c-e.md#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | #### Example @@ -222,7 +222,7 @@ Contains the response to the request to update the company. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/saas/types-c-e.md#company) | The updated company instance. | #### Example @@ -240,7 +240,7 @@ Contains the response to the request to update the company role. | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](types-c-e.md#companyrole) | The updated company role instance. | +| `role` - [`CompanyRole!`](/reference/graphql/saas/types-c-e.md#companyrole) | The updated company role instance. | #### Example @@ -258,7 +258,7 @@ Contains the response to the request to update the company structure. | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](types-c-e.md#company) | The updated company instance. | +| `company` - [`Company!`](/reference/graphql/saas/types-c-e.md#company) | The updated company instance. | #### Example @@ -276,7 +276,7 @@ Contains the response to the request to update a company team. | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](types-c-e.md#companyteam) | The updated company team instance. | +| `team` - [`CompanyTeam!`](/reference/graphql/saas/types-c-e.md#companyteam) | The updated company team instance. | #### Example @@ -294,7 +294,7 @@ Contains the response to the request to update the company user. | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](types-c-e.md#customer) | The updated company user instance. | +| `user` - [`Customer!`](/reference/graphql/saas/types-c-e.md#customer) | The updated company user instance. | #### Example @@ -312,12 +312,12 @@ Defines updates to a `GiftRegistry` object. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](types-q-s.md#string) | The updated name of the event. | -| `message` - [`String`](types-q-s.md#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/saas/types-f-i.md#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated name of the event. | +| `message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](/reference/graphql/saas/types-f-i.md#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](/reference/graphql/saas/types-f-i.md#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](/reference/graphql/saas/types-f-i.md#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | #### Example @@ -344,16 +344,16 @@ Defines updates to an item in a gift registry. | Input Field | Description | |-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](types-q-s.md#string) | The updated description of the item. | -| `quantity` - [`Float!`](types-f-i.md#float) | The updated quantity of the gift registry item. | +| `gift_registry_item_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated description of the item. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The updated quantity of the gift registry item. | #### Example ```json { "gift_registry_item_uid": "4", - "note": "xyz789", + "note": "abc123", "quantity": 123.45 } ``` @@ -368,7 +368,7 @@ Contains the results of a request to update gift registry items. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating updating items. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The gift registry after updating updating items. | #### Example @@ -386,7 +386,7 @@ Contains the results of a request to update a gift registry. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The updated gift registry. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The updated gift registry. | #### Example @@ -404,11 +404,11 @@ Defines updates to an existing registrant. | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](types-f-i.md#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`](types-q-s.md#string) | The updated email address of the registrant. | -| `firstname` - [`String`](types-q-s.md#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](types-q-s.md#string) | The updated last name of the registrant. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](/reference/graphql/saas/types-f-i.md#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`](/reference/graphql/saas/types-q-s.md#string) | The updated email address of the registrant. | +| `firstname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated last name of the registrant. | #### Example @@ -420,7 +420,7 @@ Defines updates to an existing registrant. "email": "abc123", "firstname": "abc123", "gift_registry_registrant_uid": 4, - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -434,7 +434,7 @@ Contains the results a request to update registrants. | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](types-f-i.md#giftregistry) | The gift registry after updating registrants. | +| `gift_registry` - [`GiftRegistry`](/reference/graphql/saas/types-f-i.md#giftregistry) | The gift registry after updating registrants. | #### Example @@ -452,7 +452,7 @@ Contains the updated negotiable quote. | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](types-k-p.md#negotiablequote) | The updated negotiable quote. | +| `quote` - [`NegotiableQuote`](/reference/graphql/saas/types-k-p.md#negotiablequote) | The updated negotiable quote. | #### Example @@ -470,8 +470,8 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](/reference/graphql/saas/types-k-p.md#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuote` object. | #### Example @@ -492,7 +492,7 @@ Contains the updated negotiable quote template. | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote_template` - [`NegotiableQuoteTemplate`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplate) | The updated negotiable quote template. | #### Example @@ -510,8 +510,8 @@ Specifies the items to update. | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](/reference/graphql/saas/types-k-p.md#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example @@ -554,22 +554,22 @@ Defines the changes to be made to an approval rule. | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]`](types-f-i.md#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]`](types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](types-q-s.md#string) | The updated approval rule description. | -| `name` - [`String`](types-q-s.md#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](types-f-i.md#id) | Unique identifier for the purchase order approval rule. | +| `applies_to` - [`[ID]`](/reference/graphql/saas/types-f-i.md#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]`](/reference/graphql/saas/types-f-i.md#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](/reference/graphql/saas/types-c-e.md#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated approval rule description. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | Unique identifier for the purchase order approval rule. | #### Example ```json { - "applies_to": [4], - "approvers": ["4"], + "applies_to": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", + "description": "abc123", "name": "xyz789", "status": "ENABLED", "uid": 4 @@ -586,8 +586,8 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | The updated description of the requisition list. | -| `name` - [`String!`](types-q-s.md#string) | The new name of the requisition list. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated description of the requisition list. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The new name of the requisition list. | #### Example @@ -608,17 +608,17 @@ Defines which items in a requisition list to update. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](types-f-i.md#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](types-f-i.md#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](types-q-s.md#string) | An array of selected option IDs. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/saas/types-c-e.md#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](/reference/graphql/saas/types-q-s.md#string) | An array of selected option IDs. | #### Example ```json { "entered_options": [EnteredOptionInput], - "item_id": 4, + "item_id": "4", "quantity": 123.45, "selected_options": ["abc123"] } @@ -634,7 +634,7 @@ Output of the request to update items in the specified requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The requisition list after updating items. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The requisition list after updating items. | #### Example @@ -652,7 +652,7 @@ Output of the request to rename the requisition list. | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](types-q-s.md#requisitionlist) | The renamed requisition list. | +| `requisition_list` - [`RequisitionList`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The renamed requisition list. | #### Example @@ -670,8 +670,8 @@ Contains the name and visibility of an updated wish list. | Field Name | Description | |------------|-------------| -| `name` - [`String!`](types-q-s.md#string) | The wish list name. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID of a `Wishlist` object. | +| `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The wish list name. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of a `Wishlist` object. | | `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example @@ -679,7 +679,7 @@ Contains the name and visibility of an updated wish list. ```json { "name": "abc123", - "uid": "4", + "uid": 4, "visibility": "PUBLIC" } ``` @@ -694,16 +694,16 @@ Defines the input for returning matching companies the customer is assigned to. | Input Field | Description | |-------------|-------------| -| `currentPage` - [`Int`](types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | -| `pageSize` - [`Int`](types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | -| `sort` - [`[CompaniesSortInput]`](types-c-e.md#companiessortinput) | Defines the sorting of the results. | +| `currentPage` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](/reference/graphql/saas/types-c-e.md#companiessortinput) | Defines the sorting of the results. | #### Example ```json { - "currentPage": 987, - "pageSize": 123, + "currentPage": 123, + "pageSize": 987, "sort": [CompaniesSortInput] } ``` @@ -718,8 +718,8 @@ An object that contains a list of companies customer is assigned to. | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | +| `items` - [`[CompanyBasicInfo]!`](/reference/graphql/saas/types-c-e.md#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Provides navigation for the query response. | #### Example @@ -740,7 +740,7 @@ Contains details about a failed validation attempt. | Field Name | Description | |------------|-------------| -| `message` - [`String!`](types-q-s.md#string) | The returned error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The returned error message. | | `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | #### Example @@ -779,7 +779,7 @@ Defines the purchase orders to be validated. | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](types-f-i.md#id) | An array of the purchase order IDs. | +| `purchase_order_uids` - [`[ID]!`](/reference/graphql/saas/types-f-i.md#id) | An array of the purchase order IDs. | #### Example @@ -798,7 +798,7 @@ Contains the results of validation attempts. | Field Name | Description | |------------|-------------| | `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | +| `purchase_orders` - [`[PurchaseOrder]!`](/reference/graphql/saas/types-k-p.md#purchaseorder) | An array of the purchase orders in the request. | #### Example @@ -820,7 +820,7 @@ Defines a customer attribute validation rule. | Field Name | Description | |------------|-------------| | `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](types-q-s.md#string) | Validation rule value. | +| `value` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Validation rule value. | #### Example @@ -883,8 +883,8 @@ Retrieves the vault configuration | Field Name | Description | |------------|-------------| -| `is_vault_enabled` - [`Boolean`](types-a-b.md#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | +| `is_vault_enabled` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](/reference/graphql/saas/types-q-s.md#sdkparams) | The parameters required to load the Paypal JS SDK | | `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | #### Example @@ -907,18 +907,18 @@ Vault payment inputs | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](types-q-s.md#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](types-q-s.md#string) | The payment services order ID | -| `paypal_order_id` - [`String`](types-q-s.md#string) | PayPal order ID | -| `public_hash` - [`String`](types-q-s.md#string) | The public hash of the token. | +| `payment_source` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The payment services order ID | +| `paypal_order_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | PayPal order ID | +| `public_hash` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The public hash of the token. | #### Example ```json { - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "abc123", - "paypal_order_id": "xyz789", + "paypal_order_id": "abc123", "public_hash": "xyz789" } ``` @@ -933,7 +933,7 @@ The payment source information | Input Field | Description | |-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](types-k-p.md#paymentsourceinput) | The payment source information | +| `payment_source` - [`PaymentSourceInput!`](/reference/graphql/saas/types-k-p.md#paymentsourceinput) | The payment source information | #### Example @@ -951,15 +951,15 @@ User view history | Input Field | Description | |-------------|-------------| -| `date` - [`DateTime`](types-c-e.md#datetime) | | -| `sku` - [`String`](types-q-s.md#string) | | +| `date` - [`DateTime`](/reference/graphql/saas/types-c-e.md#datetime) | | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | | #### Example ```json { "date": "2007-12-03T10:15:30Z", - "sku": "abc123" + "sku": "xyz789" } ``` @@ -973,8 +973,8 @@ User view history | Input Field | Description | |-------------|-------------| -| `dateTime` - [`DateTime`](types-c-e.md#datetime) | | -| `sku` - [`String!`](types-q-s.md#string) | | +| `dateTime` - [`DateTime`](/reference/graphql/saas/types-c-e.md#datetime) | | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | #### Example @@ -995,42 +995,42 @@ An implementation for virtual product cart items. | Field Name | Description | |------------|-------------| -| `backorder_message` - [`String`](types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `custom_attributes` - [`[CustomAttribute]`](types-c-e.md#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `discount` - [`[Discount]`](types-c-e.md#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | -| `is_available` - [`Boolean!`](types-a-b.md#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!`](types-a-b.md#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`](types-f-i.md#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](types-f-i.md#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](types-f-i.md#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](types-f-i.md#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | +| `backorder_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](/reference/graphql/saas/types-c-e.md#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](/reference/graphql/saas/types-c-e.md#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](/reference/graphql/saas/types-c-e.md#cartitemerror) | An array of errors encountered while loading the cart item | +| `is_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#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!`](/reference/graphql/saas/types-a-b.md#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`](/reference/graphql/saas/types-f-i.md#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](/reference/graphql/saas/types-f-i.md#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](/reference/graphql/saas/types-c-e.md#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "backorder_message": "abc123", + "backorder_message": "xyz789", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "is_available": true, + "is_available": false, "is_salable": false, "max_qty": 123.45, "min_qty": 123.45, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" } ``` @@ -1045,54 +1045,54 @@ Defines a virtual product, which is a non-tangible product that does not require | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](types-q-s.md#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]`](types-c-e.md#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](types-q-s.md#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](types-k-p.md#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](types-q-s.md#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](types-f-i.md#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](types-q-s.md#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](types-q-s.md#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](types-f-i.md#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](types-k-p.md#pricerange) | The range of prices for the product | +| `canonical_url` - [`String`](/reference/graphql/saas/types-q-s.md#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]`](/reference/graphql/saas/types-c-e.md#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](/reference/graphql/saas/types-k-p.md#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](/reference/graphql/saas/types-k-p.md#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](/reference/graphql/saas/types-k-p.md#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](/reference/graphql/saas/types-c-e.md#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](/reference/graphql/saas/types-q-s.md#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](/reference/graphql/saas/types-k-p.md#pricerange) | The range of prices for the product | | `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](types-f-i.md#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](types-f-i.md#float) | The discounted price of the product. | -| `special_to_date` - [`String`](types-q-s.md#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](types-k-p.md#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](types-q-s.md#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](types-k-p.md#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](types-k-p.md#productinterface) | Upsell Products | -| `url_key` - [`String`](types-q-s.md#string) | The part of the URL that identifies the product | +| `product_links` - [`[ProductLinksInterface]`](/reference/graphql/saas/types-k-p.md#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](/reference/graphql/saas/types-c-e.md#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The discounted price of the product. | +| `special_to_date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](/reference/graphql/saas/types-k-p.md#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](/reference/graphql/saas/types-k-p.md#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](/reference/graphql/saas/types-k-p.md#productinterface) | Upsell Products | +| `url_key` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The part of the URL that identifies the product | #### Example ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -1100,32 +1100,32 @@ Defines a virtual product, which is a non-tangible product that does not require "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "manufacturer": 987, - "max_sale_qty": 123.45, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", "new_from_date": "abc123", "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 123.45, - "special_to_date": "xyz789", + "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "uid": "4", "upsell_products": [ProductInterface], @@ -1143,11 +1143,11 @@ Contains details about virtual products added to a requisition list. | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount added. | -| `sku` - [`String!`](types-q-s.md#string) | The product SKU. | -| `uid` - [`ID!`](types-f-i.md#id) | The unique ID for the requisition list item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The amount added. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The product SKU. | +| `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for the requisition list item. | #### Example @@ -1156,7 +1156,7 @@ Contains details about virtual products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "sku": "abc123", + "sku": "xyz789", "uid": 4 } ``` @@ -1171,12 +1171,12 @@ Contains a virtual product wish list item. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this wish list item. | #### Example @@ -1185,7 +1185,7 @@ Contains a virtual product wish list item. "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": 4, + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -1202,14 +1202,14 @@ An error encountered while performing operations with WishList. | Field Name | Description | |------------|-------------| | `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | #### Example ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -1242,24 +1242,24 @@ Contains a customer wish list. | Field Name | Description | |------------|-------------| -| `id` - [`ID`](types-f-i.md#id) | The unique ID for a `Wishlist` object. | -| `items_count` - [`Int`](types-f-i.md#int) | The number of items in the wish list. | +| `id` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `Wishlist` object. | +| `items_count` - [`Int`](/reference/graphql/saas/types-f-i.md#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`](types-q-s.md#string) | The name of the wish list. | -| `sharing_code` - [`String`](types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](types-q-s.md#string) | The time of the last modification to the wish list. | +| `name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the wish list. | +| `sharing_code` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](/reference/graphql/saas/types-q-s.md#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_count": 987, + "id": "4", + "items_count": 123, "items_v2": WishlistItems, "name": "xyz789", - "sharing_code": "abc123", - "updated_at": "abc123", + "sharing_code": "xyz789", + "updated_at": "xyz789", "visibility": "PUBLIC" } ``` @@ -1275,9 +1275,9 @@ Contains details about errors encountered when a customer added wish list items | Field Name | Description | |------------|-------------| | `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](types-q-s.md#string) | A localized error message. | -| `wishlistId` - [`ID!`](types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](types-f-i.md#id) | The unique ID of the wish list item containing an error. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | +| `wishlistId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the wish list item containing an error. | #### Example @@ -1286,7 +1286,7 @@ Contains details about errors encountered when a customer added wish list items "code": "PRODUCT_NOT_FOUND", "message": "xyz789", "wishlistId": "4", - "wishlistItemId": "4" + "wishlistItemId": 4 } ``` @@ -1322,8 +1322,8 @@ Specifies the IDs of items to copy and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be copied. | #### Example @@ -1344,20 +1344,20 @@ Defines the items to add to a wish list. | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](types-q-s.md#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](types-f-i.md#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](types-q-s.md#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/saas/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](/reference/graphql/saas/types-q-s.md#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](/reference/graphql/saas/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#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], + "parent_sku": "xyz789", + "quantity": 987.65, + "selected_options": ["4"], "sku": "xyz789" } ``` @@ -1372,23 +1372,23 @@ The interface for wish list items. | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](types-q-s.md#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](types-q-s.md#string) | The description of the item. | -| `id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](types-f-i.md#float) | The quantity of this wish list item. | +| `added_at` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](/reference/graphql/saas/types-q-s.md#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The description of the item. | +| `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](/reference/graphql/saas/types-k-p.md#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](/reference/graphql/saas/types-f-i.md#float) | The quantity of this wish list item. | #### Possible Types | WishlistItemInterface Types | |----------------| -| [`BundleWishlistItem`](types-a-b.md#bundlewishlistitem) | -| [`ConfigurableWishlistItem`](types-c-e.md#configurablewishlistitem) | -| [`DownloadableWishlistItem`](types-c-e.md#downloadablewishlistitem) | -| [`GiftCardWishlistItem`](types-f-i.md#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](types-f-i.md#groupedproductwishlistitem) | -| [`SimpleWishlistItem`](types-q-s.md#simplewishlistitem) | +| [`BundleWishlistItem`](/reference/graphql/saas/types-a-b.md#bundlewishlistitem) | +| [`ConfigurableWishlistItem`](/reference/graphql/saas/types-c-e.md#configurablewishlistitem) | +| [`DownloadableWishlistItem`](/reference/graphql/saas/types-c-e.md#downloadablewishlistitem) | +| [`GiftCardWishlistItem`](/reference/graphql/saas/types-f-i.md#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](/reference/graphql/saas/types-f-i.md#groupedproductwishlistitem) | +| [`SimpleWishlistItem`](/reference/graphql/saas/types-q-s.md#simplewishlistitem) | | [`VirtualWishlistItem`](#virtualwishlistitem) | #### Example @@ -1397,8 +1397,8 @@ The interface for wish list items. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, + "description": "abc123", + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -1414,13 +1414,16 @@ Specifies the IDs of the items to move and their quantities. | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float`](types-f-i.md#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!`](types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#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!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID of the `WishlistItemInterface` object to be moved. | #### Example ```json -{"quantity": 123.45, "wishlist_item_id": 4} +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} ``` @@ -1433,11 +1436,11 @@ Defines updates to items in a wish list. | Input Field | Description | |-------------|-------------| -| `description` - [`String`](types-q-s.md#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](types-f-i.md#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](types-f-i.md#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | +| `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](/reference/graphql/saas/types-c-e.md#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](/reference/graphql/saas/types-f-i.md#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique ID for a `WishlistItemInterface` object. | #### Example @@ -1446,7 +1449,7 @@ Defines updates to items in a wish list. "description": "abc123", "entered_options": [EnteredOptionInput], "quantity": 123.45, - "selected_options": [4], + "selected_options": ["4"], "wishlist_item_id": 4 } ``` @@ -1462,7 +1465,7 @@ Contains an array of items in a wish list. | Field Name | Description | |------------|-------------| | `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | +| `page_info` - [`SearchResultPageInfo`](/reference/graphql/saas/types-q-s.md#searchresultpageinfo) | Contains pagination metadata. | #### Example